pyrecest 2.2.2__tar.gz → 2.2.4__tar.gz

pyrecest-2.2.2/README.md → pyrecest-2.2.4/PKG-INFO

@@ -1,5 +1,52 @@
+Metadata-Version: 2.4
+Name: pyrecest
+Version: 2.2.4
+Summary: Framework for recursive Bayesian estimation in Python.
+License: MIT
+License-File: LICENSE
+Keywords: bayesian-filtering,recursive-estimation,tracking,multi-target-tracking,manifolds,directional-statistics
+Author: Florian Pfaff
+Author-email: pfaff@ias.uni-stuttgart.de
+Requires-Python: >=3.11,<3.15
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Provides-Extra: all-support
+Provides-Extra: healpy-support
+Provides-Extra: jax-support
+Provides-Extra: pytorch-support
+Requires-Dist: autograd (>=1.7,<2.0) ; extra == "jax-support" or extra == "all-support"
+Requires-Dist: beartype (>=0.18,<0.23)
+Requires-Dist: healpy (>=1.17,<2.0) ; extra == "healpy-support" or extra == "all-support"
+Requires-Dist: jax (>=0.4.30,<0.11) ; extra == "jax-support" or extra == "all-support"
+Requires-Dist: jaxlib (>=0.4.30,<0.11) ; extra == "jax-support" or extra == "all-support"
+Requires-Dist: matplotlib (>=3.8,<4.0)
+Requires-Dist: mpmath (>=1.3,<1.4)
+Requires-Dist: numpy (>=2.0,<2.5)
+Requires-Dist: pyshtools (>=4.12,<5.0)
+Requires-Dist: scipy (>=1.14,<1.18)
+Requires-Dist: shapely (>=2.0,<3.0)
+Requires-Dist: torch (>=2.4,<3.0) ; extra == "pytorch-support" or extra == "all-support"
+Project-URL: Documentation, https://florianpfaff.github.io/PyRecEst/
+Project-URL: Homepage, https://github.com/FlorianPfaff/PyRecEst
+Project-URL: Issues, https://github.com/FlorianPfaff/PyRecEst/issues
+Project-URL: Repository, https://github.com/FlorianPfaff/PyRecEst
+Description-Content-Type: text/markdown
+
 # PyRecEst
 
+[![Tests](https://github.com/FlorianPfaff/PyRecEst/actions/workflows/tests.yml/badge.svg)](https://github.com/FlorianPfaff/PyRecEst/actions/workflows/tests.yml)
+[![PyPI version](https://img.shields.io/pypi/v/pyrecest.svg)](https://pypi.org/project/pyrecest/)
+[![Python versions](https://img.shields.io/pypi/pyversions/pyrecest.svg)](https://pypi.org/project/pyrecest/)
+[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://florianpfaff.github.io/PyRecEst/)
+
 Recursive Bayesian Estimation for Python.
 
 PyRecEst is a Python library for recursive Bayesian estimation on Euclidean
@@ -16,6 +63,37 @@ PyRecEst provides tools for:
 - evaluation of filters and trackers; and
 - sampling distributions and generating grids.
 
+## Which API Should I Start With?
+
+| Task                                                    | Start with                                                       |
+|---------------------------------------------------------|------------------------------------------------------------------|
+| Linear Euclidean Gaussian filtering                     | `KalmanFilter` and `examples/basic/kalman_filter.py`             |
+| Reusable transition and measurement models              | `examples/basic/kalman_filter_with_models.py`                    |
+| Nonlinear filtering                                     | `examples/basic/ukf_with_models.py` or particle-filter examples  |
+| Multi-target tracking with clutter or missed detections | `examples/basic/multi_target_tracking.py`                        |
+| Circular, spherical, or manifold-valued states          | circular, hypertoroidal, and hyperspherical distribution modules |
+| Backend-portable code                                   | `pyrecest.backend` imports plus focused tests under each backend |
+
+For more detail, see `docs/choosing-an-api.md` and `docs/backend-compatibility.md`.
+
+## Command Line And Reproducible Scenarios
+
+After installation, use the lightweight CLI to inspect an environment or run a
+reproducible scenario:
+
+```bash
+pyrecest info
+pyrecest backends --format markdown
+pyrecest run-scenario scenarios/linear_gaussian_cv_1d/config.toml
+```
+
+The same scenario runner is available from a source checkout via
+`scripts/run_scenario.py`. Scenario definitions live in `scenarios/` and include
+TOML configuration plus JSON golden outputs.
+
+The `pyrecest.diagnostics` module defines common diagnostics containers for
+innovation statistics, particle-filter health, and association decisions.
+
 ## Installation
 
 PyRecEst requires Python 3.11 or newer and earlier than Python 3.15.
@@ -32,8 +110,14 @@ Optional backend and domain-specific dependencies can be installed with extras:
 python -m pip install "pyrecest[pytorch_support]"
 python -m pip install "pyrecest[jax_support]"
 python -m pip install "pyrecest[healpy_support]"
+python -m pip install "pyrecest[all_support]"
 ```
 
+Pip normalizes extra names, so the equivalent hyphenated spellings such as
+`pyrecest[pytorch-support]`, `pyrecest[jax-support]`,
+`pyrecest[healpy-support]`, and `pyrecest[all-support]` may also appear in
+package-index metadata.
+
 For development from a source checkout, use Poetry or the provided conda
 environment:
 
@@ -87,6 +171,12 @@ The `docs/` directory contains the first project documentation pages:
   most common public entry points.
 - [Backend compatibility](docs/backend-compatibility.md) explains the NumPy,
   PyTorch, and JAX support model and known limitations.
+- [Choosing an API](docs/choosing-an-api.md) maps task families to recommended
+  filters, distributions, trackers, and examples.
+- [Distribution taxonomy](docs/distribution-taxonomy.md) summarizes the main
+  representation families by domain and use case.
+- [Error handling](docs/error-handling.md) documents the shared exception types
+  and user-facing diagnostics policy.
 - [API reference](docs/reference/index.md) contains generated package reference
   pages built with MkDocs and mkdocstrings.
 - [Task tutorials](docs/tutorials/index.md) show common distribution, filtering,
@@ -120,6 +210,8 @@ Install the matching optional extra before using a non-default backend.
 
 - `examples/basic/kalman_filter.py` contains a small executable Kalman filter
   example.
+- `examples/basic/scgp_measurement_reliability.py` demonstrates
+  reliability-weighted measurements for the full SCGP extended-object tracker.
 - `tests/` contains additional usage examples for distributions, filters,
   smoothers, evaluation, sampling, metrics, and tracking utilities.
 
@@ -173,3 +265,4 @@ backend implementations are based on those of
 
 ## License
 `PyRecEst` is licensed under the MIT License.
+

pyrecest-2.2.2/PKG-INFO → pyrecest-2.2.4/README.md

@@ -1,35 +1,10 @@
-Metadata-Version: 2.4
-Name: pyrecest
-Version: 2.2.2
-Summary: Framework for recursive Bayesian estimation in Python.
-License-File: LICENSE
-Author: Florian Pfaff
-Author-email: pfaff@ias.uni-stuttgart.de
-Requires-Python: >=3.11,<3.15
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Provides-Extra: healpy-support
-Provides-Extra: jax-support
-Provides-Extra: pytorch-support
-Requires-Dist: autograd ; extra == "jax-support"
-Requires-Dist: beartype
-Requires-Dist: healpy ; extra == "healpy-support"
-Requires-Dist: jax ; extra == "jax-support"
-Requires-Dist: jaxlib ; extra == "jax-support"
-Requires-Dist: matplotlib
-Requires-Dist: mpmath
-Requires-Dist: numpy
-Requires-Dist: pyshtools
-Requires-Dist: scipy (>=1.17.1,<2.0.0)
-Requires-Dist: shapely
-Requires-Dist: torch ; extra == "pytorch-support"
-Description-Content-Type: text/markdown
-
 # PyRecEst
 
+[![Tests](https://github.com/FlorianPfaff/PyRecEst/actions/workflows/tests.yml/badge.svg)](https://github.com/FlorianPfaff/PyRecEst/actions/workflows/tests.yml)
+[![PyPI version](https://img.shields.io/pypi/v/pyrecest.svg)](https://pypi.org/project/pyrecest/)
+[![Python versions](https://img.shields.io/pypi/pyversions/pyrecest.svg)](https://pypi.org/project/pyrecest/)
+[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://florianpfaff.github.io/PyRecEst/)
+
 Recursive Bayesian Estimation for Python.
 
 PyRecEst is a Python library for recursive Bayesian estimation on Euclidean
@@ -46,6 +21,37 @@ PyRecEst provides tools for:
 - evaluation of filters and trackers; and
 - sampling distributions and generating grids.
 
+## Which API Should I Start With?
+
+| Task                                                    | Start with                                                       |
+|---------------------------------------------------------|------------------------------------------------------------------|
+| Linear Euclidean Gaussian filtering                     | `KalmanFilter` and `examples/basic/kalman_filter.py`             |
+| Reusable transition and measurement models              | `examples/basic/kalman_filter_with_models.py`                    |
+| Nonlinear filtering                                     | `examples/basic/ukf_with_models.py` or particle-filter examples  |
+| Multi-target tracking with clutter or missed detections | `examples/basic/multi_target_tracking.py`                        |
+| Circular, spherical, or manifold-valued states          | circular, hypertoroidal, and hyperspherical distribution modules |
+| Backend-portable code                                   | `pyrecest.backend` imports plus focused tests under each backend |
+
+For more detail, see `docs/choosing-an-api.md` and `docs/backend-compatibility.md`.
+
+## Command Line And Reproducible Scenarios
+
+After installation, use the lightweight CLI to inspect an environment or run a
+reproducible scenario:
+
+```bash
+pyrecest info
+pyrecest backends --format markdown
+pyrecest run-scenario scenarios/linear_gaussian_cv_1d/config.toml
+```
+
+The same scenario runner is available from a source checkout via
+`scripts/run_scenario.py`. Scenario definitions live in `scenarios/` and include
+TOML configuration plus JSON golden outputs.
+
+The `pyrecest.diagnostics` module defines common diagnostics containers for
+innovation statistics, particle-filter health, and association decisions.
+
 ## Installation
 
 PyRecEst requires Python 3.11 or newer and earlier than Python 3.15.
@@ -62,8 +68,14 @@ Optional backend and domain-specific dependencies can be installed with extras:
 python -m pip install "pyrecest[pytorch_support]"
 python -m pip install "pyrecest[jax_support]"
 python -m pip install "pyrecest[healpy_support]"
+python -m pip install "pyrecest[all_support]"
 ```
 
+Pip normalizes extra names, so the equivalent hyphenated spellings such as
+`pyrecest[pytorch-support]`, `pyrecest[jax-support]`,
+`pyrecest[healpy-support]`, and `pyrecest[all-support]` may also appear in
+package-index metadata.
+
 For development from a source checkout, use Poetry or the provided conda
 environment:
 
@@ -117,6 +129,12 @@ The `docs/` directory contains the first project documentation pages:
   most common public entry points.
 - [Backend compatibility](docs/backend-compatibility.md) explains the NumPy,
   PyTorch, and JAX support model and known limitations.
+- [Choosing an API](docs/choosing-an-api.md) maps task families to recommended
+  filters, distributions, trackers, and examples.
+- [Distribution taxonomy](docs/distribution-taxonomy.md) summarizes the main
+  representation families by domain and use case.
+- [Error handling](docs/error-handling.md) documents the shared exception types
+  and user-facing diagnostics policy.
 - [API reference](docs/reference/index.md) contains generated package reference
   pages built with MkDocs and mkdocstrings.
 - [Task tutorials](docs/tutorials/index.md) show common distribution, filtering,
@@ -150,6 +168,8 @@ Install the matching optional extra before using a non-default backend.
 
 - `examples/basic/kalman_filter.py` contains a small executable Kalman filter
   example.
+- `examples/basic/scgp_measurement_reliability.py` demonstrates
+  reliability-weighted measurements for the full SCGP extended-object tracker.
 - `tests/` contains additional usage examples for distributions, filters,
   smoothers, evaluation, sampling, metrics, and tracking utilities.
 
@@ -203,4 +223,3 @@ backend implementations are based on those of
 
 ## License
 `PyRecEst` is licensed under the MIT License.
-

pyrecest-2.2.4/pyproject.toml

@@ -0,0 +1,165 @@
+[tool.poetry]
+name = "pyrecest"
+description = "Framework for recursive Bayesian estimation in Python."
+readme = "README.md"
+authors = ["Florian Pfaff <pfaff@ias.uni-stuttgart.de>"]
+version = "2.2.4"
+include = ["src/pyrecest/py.typed"]
+license = "MIT"
+keywords = [
+  "bayesian-filtering",
+  "recursive-estimation",
+  "tracking",
+  "multi-target-tracking",
+  "manifolds",
+  "directional-statistics",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Scientific/Engineering",
+]
+
+[tool.poetry.urls]
+Homepage = "https://github.com/FlorianPfaff/PyRecEst"
+Documentation = "https://florianpfaff.github.io/PyRecEst/"
+Repository = "https://github.com/FlorianPfaff/PyRecEst"
+Issues = "https://github.com/FlorianPfaff/PyRecEst/issues"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+ 
+[tool.poetry.dependencies]
+python = ">=3.11,<3.15"
+numpy = ">=2.0,<2.5"
+scipy = ">=1.14,<1.18"
+matplotlib = ">=3.8,<4.0"
+mpmath = ">=1.3,<1.4"
+pyshtools = ">=4.12,<5.0"
+beartype = ">=0.18,<0.23"
+shapely = ">=2.0,<3.0"
+healpy = { version = ">=1.17,<2.0", optional = true }
+torch = { version = ">=2.4,<3.0", optional = true }
+jax = { version = ">=0.4.30,<0.11", optional = true }
+jaxlib = { version = ">=0.4.30,<0.11", optional = true }
+autograd = { version = ">=1.7,<2.0", optional = true }
+
+[tool.poetry.scripts]
+pyrecest = "pyrecest.cli:main"
+
+[tool.poetry.extras]
+healpy_support = ["healpy"]
+pytorch_support = ["torch"]
+jax_support = ["jax", "jaxlib", "autograd"]
+all_support = ["healpy", "torch", "jax", "jaxlib", "autograd"]
+
+[tool.poetry.group.dev.dependencies]
+autopep8 = "^2.3.2"
+pytest = ">=8,<10"
+pytest-cov = ">=5,<8"
+parameterized = ">=0.9,<1.0"
+nox = ">=2024.10,<2027.0"
+pytest-benchmark = ">=4.0,<6.0"
+asv = ">=0.6,<1.0"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.6.1"
+mkdocstrings = { version = "^1.0.4", extras = ["python"] }
+
+[tool.mypy]
+check_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = [
+  "pyrecest.diagnostics",
+  "pyrecest.reproducibility",
+  "pyrecest.scenarios",
+]
+disallow_untyped_defs = true
+warn_return_any = true
+
+[tool.ruff]
+line-length = 180
+
+[tool.ruff.lint]
+select = ["F821", "F822", "F823"]
+
+[tool.isort]
+profile = "black"
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore::DeprecationWarning:mpmath.*",
+    "ignore::scipy.optimize.OptimizeWarning",
+    "ignore:'return' in a 'finally' block:SyntaxWarning:autograd\\.wrap_util",
+]
+markers = [
+    "numerical_stress: slower numerical stability and ill-conditioning checks",
+    "benchmark: optional performance benchmark tests",
+    "backend_portable: subprocess-based checks that verify import-time backend portability",
+    "doc_example: executable documentation examples",
+    "validation: closed-form or reference-result algorithm validation tests",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["pyrecest"]
+omit = [
+  "*/tests/*",
+  "*/benchmarks/*",
+]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+fail_under = 20
+exclude_lines = [
+  "pragma: no cover",
+  "if TYPE_CHECKING:",
+  "if __name__ == .__main__.:",
+]
+[tool.pylint.MAIN]
+py-version = "3.13"
+fail-under = 10
+ignore = ["CVS"]
+ignored-modules = ["pyrecest.backend", "healpy", "torch", "jax", "jaxlib"]
+
+[tool.pylint."MESSAGES CONTROL"]
+disable = [
+  "raw-checker-failed",
+  "bad-inline-option",
+  "locally-disabled",
+  "file-ignored",
+  "suppressed-message",
+  "deprecated-pragma",
+  "use-symbolic-message-instead",
+  "C",
+  "W0221",
+  "redefined-builtin",
+  "cyclic-import",
+  "too-many-locals",
+  "too-many-return-statements",
+  "too-many-branches",
+  "too-many-statements",
+  "too-many-arguments",
+  "too-many-positional-arguments",
+  "too-many-instance-attributes",
+  "duplicate-code",
+]
+
+[tool.pylint.FORMAT]
+max-line-length = 180
+
+[tool.pylint.DESIGN]
+max-args = 6
+max-parents = 15
+max-public-methods = 25
+min-public-methods = 0

pyrecest-2.2.4/src/pyrecest/__init__.py

@@ -0,0 +1,58 @@
+from importlib.metadata import PackageNotFoundError, version
+
+import pyrecest._backend  # noqa
+from pyrecest.backend import copy  # noqa: F401
+from pyrecest.backend_support import (  # noqa: F401
+    backend_support,
+    format_backend_support_markdown,
+    get_backend_support,
+)
+from pyrecest.backend_tools import (  # noqa: F401
+    assert_backend,
+    get_backend_name,
+    is_backend,
+    warn_if_backend_env_changed,
+)
+from pyrecest.exceptions import (  # noqa: F401
+    BackendNotSupportedError,
+    BackendSupportError,
+    DimensionMismatchError,
+    NumericalStabilityError,
+    OptionalDependencyError,
+    PyRecEstError,
+    ShapeError,
+    ValidationError,
+)
+from pyrecest.stability import (  # noqa: F401
+    get_public_api_status,
+    iter_public_api_status,
+    stability,
+)
+
+try:
+    __version__ = version("pyrecest")
+except PackageNotFoundError:  # pragma: no cover - source tree without install metadata
+    __version__ = "0+unknown"
+
+__all__ = [
+    "BackendNotSupportedError",
+    "BackendSupportError",
+    "DimensionMismatchError",
+    "NumericalStabilityError",
+    "OptionalDependencyError",
+    "PyRecEstError",
+    "ShapeError",
+    "ValidationError",
+    "__version__",
+    "assert_backend",
+    "backend_support",
+    "copy",
+    "format_backend_support_markdown",
+    "get_backend_name",
+    "get_backend_support",
+    "get_public_api_status",
+    "is_backend",
+    "iter_public_api_status",
+    "stability",
+    "warn_if_backend_env_changed",
+]