pyest 0.2.2__tar.gz

pyest-0.2.2/.gitattributes

@@ -0,0 +1,16 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.c text
+*.h text
+*.py text
+*.md text
+
+# Declare files that will always have CRLF line endings on checkout.
+*.sln text eol=crlf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary

pyest-0.2.2/.github/workflows/pythonapp.yml

@@ -0,0 +1,32 @@
+name: Python application
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pip install pytest
+        pip install -e '.[test]'
+        pytest

pyest-0.2.2/.gitignore

@@ -0,0 +1,158 @@
+# autosave files
+*.asv
+*.m~
+*.swp
+*.swo
+
+# data
+example/data/
+*.png
+*.PNG
+*.mat
+*.svg
+*.csv
+*.info
+*.parquet
+
+# matlab
+*.fig
+
+# images
+*.png
+*.jpg
+
+# videos
+*.avi
+
+# mac
+*.DS_Store
+
+*typescript                                  
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+.vscode/
+compiled_build/
+.idea/
+*.code-workspace
+
+# tags
+*tags
+
+# split cache
+pyest/gm/splitl2_cov_cache/
+pyest/gm/splitl2_cache/
+
+# benchmark data
+.benchmarks/
+

pyest-0.2.2/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

pyest-0.2.2/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+## Installation
+
+### OS X (zsh)
+
+To install everything in developer mode,
+ ```shell
+ pip install -e '.[test,examples]'
+ ```
+
+### OS X (bash), Windows (cmd prompt)
+
+To install everything in developer mode,
+ ```shell
+ pip install -e .[test,examples]
+ ```
+
+## Testing
+
+### using tox (recommended)
+If you don't already have tox installed, you can pip install it
+```
+pip install tox
+```
+
+To run unit tests, run
+```
+tox run
+```
+
+
+### using pytest
+To run unit tests, use pytest:
+
+```
+ pytest --cov=pyest --cov-report term-missing tests
+ ```
+
+To run unit tests with performance benchmarking:
+```
+pytest --benchmark-save=benchmark --benchmark-compare --cov=pyest --cov-report term-missing tests
+```
+
+## Documentation
+
+To build the documentation:
+
+```
+pip install sphinx sphinx-rtd-theme
+```
+
+Then,
+```
+cd docs
+make html
+```
+
+If you are using Windows powershell and don't have `make` installed, you can
+alternatively run
+```
+cd docs
+sphinx-build -b html . _build
+```

pyest-0.2.2/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2025 Keith LeGrand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pyest-0.2.2/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: pyest
+Version: 0.2.2
+Summary: Adaptive Gaussian Mixture State Estimation
+Project-URL: Homepage, https://github.com/scope-lab/pyest
+Project-URL: Issues, https://github.com/scope-lab/pyest
+Project-URL: Documentation, https://pyest.readthedocs.io/en/latest/
+Author: Keith A. LeGrand
+License-Expression: MIT
+License-File: LICENSE.txt
+Requires-Python: >=3.9
+Requires-Dist: cvxopt
+Requires-Dist: diskcache
+Requires-Dist: fastparquet
+Requires-Dist: huggingface-hub
+Requires-Dist: jax
+Requires-Dist: numba
+Requires-Dist: numpy
+Requires-Dist: pyarrow
+Requires-Dist: scipy
+Requires-Dist: shapely
+Provides-Extra: examples
+Requires-Dist: matplotlib; extra == 'examples'
+Requires-Dist: stmint>=1.2.1; extra == 'examples'
+Requires-Dist: sympy==1.12; extra == 'examples'
+Provides-Extra: test
+Requires-Dist: dill; extra == 'test'
+Requires-Dist: pytest-benchmark; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+![pyest_logo](./docs/image/pyest_logo.png)
+# PyEst: Gaussian Mixture Adaptive State Estimation
+
+## Basic Usage
+
+Import the `gm` module of PyEst as well as numpy and matplotlib
+```
+import numpy as np
+import matplotlib.pyplot as plt
+import pyest.gm as gm
+```
+
+Create a three-mixand two-dimensional Gaussian mixture:
+```
+# mixand means (nc,nx)
+m = np.array([[0,0], [1,2], [0,-1]])
+# mixand covariance matrices (nc,nx,nx)
+P = np.array([[[1,0], [0,1]],
+              [[2, 0.5], [0.5,3]],
+              [[0.5, -0.1], [-0.1, 1]]])
+# mixand weights (nc,)
+w = gm.equal_weights(3)
+# contruct the Gaussian mixture
+p = gm.GaussianMixture(w, m, P)
+```
+
+Compute the mean and covariance of the distribution:
+```
+# compute and print the mean
+print(p.mean())
+# compute and print the covariance
+print(p.cov())
+```
+
+Plot the Gaussian mixture
+```
+pp, XX, YY = p.pdf_2d()
+fig = plt.figure()
+ax = fig.add_axes(111)
+ax.contourf(XX,YY,pp,100)
+```
+
+Apply a linear transformation to the mixture
+```
+dt = 5
+F = np.array([[1, dt], [0, 1]])
+my = np.array([F@m for m in p.m])
+Py = np.array([F@P@F.T for P in p.P])
+py = gm.GaussianMixture(p.w, my, Py)
+```
+
+Plot the transformed Gaussian mixture
+```
+pp, XX, YY = py.pdf_2d()
+fig = plt.figure()
+ax = fig.add_axes(111)
+ax.contourf(XX,YY,pp,100)
+plt.show()
+```
+
+## Installation
+
+### OS X (zsh)
+To install, run
+```shell
+pip install .
+```
+
+To install packages needed for running the examples, run
+ ```shell
+pip install '.[examples]'
+```
+
+### OS X (bash), Windows (cmd prompt)
+To install, run
+```shell
+pip install .
+```
+
+To install packages needed for running the examples, run
+ ```shell
+pip install .[examples]
+```
+
+
+## Citing this work
+
+If you use this package in your scholarly work, please cite the following articles:
+
+[K.A. LeGrand and S. Ferrari, “Split Happens! Imprecise and Negative Information in Gaussian Mixture Random Finite Set Filtering,” Journal of Advances in Information Fusion,  Vol 17, No. 2, December, 2022](http://keithlegrand.com/wp/wp-content/uploads/2023/05/LeGrand-2022-Split-Happens-Imprecise-and-Negative-Information-in-Gaussian-Mixture-Random-Finite-Set-Filtering.pdf)
+
+J. Kulik and K.A. LeGrand, “Nonlinearity and Uncertainty Informed Moment-Matching Gaussian Mixture Splitting,” https://arxiv.org/abs/2412.00343
+
+
+```
+@article{legrand2022SplitHappensImprecise,
+  title = {Split {{Happens}}! Imprecise and Negative Information in {G}aussian Mixture Random Finite Set Filtering},
+  author = {LeGrand, Keith A. and Ferrari, Silvia},
+  year = {2022},
+  month = dec,
+  journal = {Journal of Advances in Information Fusion},
+  volume = {17},
+  number = {2},
+  eprint = {2207.11356},
+  primaryclass = {cs, eess},
+  pages = {78--96},
+  doi = {10.48550/arXiv.2207.11356},
+}
+@misc{kulik2024NonlinearityUncertaintyInformed,
+  title = {Nonlinearity and {{Uncertainty Informed Moment-Matching Gaussian Mixture Splitting}}},
+  author = {Kulik, Jackson and LeGrand, Keith A.},
+  year = {2024},
+  month = nov,
+  number = {arXiv:2412.00343},
+  eprint = {2412.00343},
+  primaryclass = {stat},
+  publisher = {arXiv},
+  doi = {10.48550/arXiv.2412.00343},
+  urldate = {2025-01-01},
+  archiveprefix = {arXiv}
+}
+
+```
+
+## Documentation
+
+For more information about PyEst, please see the [documentation](https://pyest.readthedocs.io/en/latest/).

pyest-0.2.2/README.md

@@ -0,0 +1,127 @@
+![pyest_logo](./docs/image/pyest_logo.png)
+# PyEst: Gaussian Mixture Adaptive State Estimation
+
+## Basic Usage
+
+Import the `gm` module of PyEst as well as numpy and matplotlib
+```
+import numpy as np
+import matplotlib.pyplot as plt
+import pyest.gm as gm
+```
+
+Create a three-mixand two-dimensional Gaussian mixture:
+```
+# mixand means (nc,nx)
+m = np.array([[0,0], [1,2], [0,-1]])
+# mixand covariance matrices (nc,nx,nx)
+P = np.array([[[1,0], [0,1]],
+              [[2, 0.5], [0.5,3]],
+              [[0.5, -0.1], [-0.1, 1]]])
+# mixand weights (nc,)
+w = gm.equal_weights(3)
+# contruct the Gaussian mixture
+p = gm.GaussianMixture(w, m, P)
+```
+
+Compute the mean and covariance of the distribution:
+```
+# compute and print the mean
+print(p.mean())
+# compute and print the covariance
+print(p.cov())
+```
+
+Plot the Gaussian mixture
+```
+pp, XX, YY = p.pdf_2d()
+fig = plt.figure()
+ax = fig.add_axes(111)
+ax.contourf(XX,YY,pp,100)
+```
+
+Apply a linear transformation to the mixture
+```
+dt = 5
+F = np.array([[1, dt], [0, 1]])
+my = np.array([F@m for m in p.m])
+Py = np.array([F@P@F.T for P in p.P])
+py = gm.GaussianMixture(p.w, my, Py)
+```
+
+Plot the transformed Gaussian mixture
+```
+pp, XX, YY = py.pdf_2d()
+fig = plt.figure()
+ax = fig.add_axes(111)
+ax.contourf(XX,YY,pp,100)
+plt.show()
+```
+
+## Installation
+
+### OS X (zsh)
+To install, run
+```shell
+pip install .
+```
+
+To install packages needed for running the examples, run
+ ```shell
+pip install '.[examples]'
+```
+
+### OS X (bash), Windows (cmd prompt)
+To install, run
+```shell
+pip install .
+```
+
+To install packages needed for running the examples, run
+ ```shell
+pip install .[examples]
+```
+
+
+## Citing this work
+
+If you use this package in your scholarly work, please cite the following articles:
+
+[K.A. LeGrand and S. Ferrari, “Split Happens! Imprecise and Negative Information in Gaussian Mixture Random Finite Set Filtering,” Journal of Advances in Information Fusion,  Vol 17, No. 2, December, 2022](http://keithlegrand.com/wp/wp-content/uploads/2023/05/LeGrand-2022-Split-Happens-Imprecise-and-Negative-Information-in-Gaussian-Mixture-Random-Finite-Set-Filtering.pdf)
+
+J. Kulik and K.A. LeGrand, “Nonlinearity and Uncertainty Informed Moment-Matching Gaussian Mixture Splitting,” https://arxiv.org/abs/2412.00343
+
+
+```
+@article{legrand2022SplitHappensImprecise,
+  title = {Split {{Happens}}! Imprecise and Negative Information in {G}aussian Mixture Random Finite Set Filtering},
+  author = {LeGrand, Keith A. and Ferrari, Silvia},
+  year = {2022},
+  month = dec,
+  journal = {Journal of Advances in Information Fusion},
+  volume = {17},
+  number = {2},
+  eprint = {2207.11356},
+  primaryclass = {cs, eess},
+  pages = {78--96},
+  doi = {10.48550/arXiv.2207.11356},
+}
+@misc{kulik2024NonlinearityUncertaintyInformed,
+  title = {Nonlinearity and {{Uncertainty Informed Moment-Matching Gaussian Mixture Splitting}}},
+  author = {Kulik, Jackson and LeGrand, Keith A.},
+  year = {2024},
+  month = nov,
+  number = {arXiv:2412.00343},
+  eprint = {2412.00343},
+  primaryclass = {stat},
+  publisher = {arXiv},
+  doi = {10.48550/arXiv.2412.00343},
+  urldate = {2025-01-01},
+  archiveprefix = {arXiv}
+}
+
+```
+
+## Documentation
+
+For more information about PyEst, please see the [documentation](https://pyest.readthedocs.io/en/latest/).

pyest-0.2.2/docs/.gitignore

@@ -0,0 +1,30 @@
+# Sphinx build directory
+_build/
+
+# Sphinx static files
+_static/
+
+# Sphinx templates (if using defaults)
+_templates/
+
+# Python cache files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Environment files
+.env
+.venv
+env/
+venv/
+ENV/
+
+# IDE files
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db

pyest-0.2.2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pyest-0.2.2/docs/api.rst

@@ -0,0 +1,50 @@
+API Reference
+============
+
+Gaussian Mixture
+--------------
+
+.. automodule:: pyest.gm.gm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Split Methods
+-----------
+
+.. automodule:: pyest.gm.split
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Filters
+-------
+
+.. automodule:: pyest.filters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Linear Algebra
+------------
+
+.. automodule:: pyest.linalg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Metrics
+-------
+
+.. automodule:: pyest.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Sensors
+-------
+
+.. automodule:: pyest.sensors
+   :members:
+   :undoc-members:
+   :show-inheritance: