Metadata-Version: 2.3
Name: popclass
Version: 0.2.0
Summary: A python package that allows flexable, probabilistic classification of a microlensing event
Project-URL: Homepage, https://github.com/llnl/popclass
Project-URL: Documentation, https://popclass.readthedocs.io
Project-URL: Repository, https://github.com/llnl/popclass
Project-URL: Issues, https://github.com/llnl/popclass/issues
Project-URL: Changelog, https://github.com/LLNL/popclass/releases
Author-email: "Greg Sallaberry, Scott E. Perkins, Peter McGill, Zofia Kaczmarek, William A. Dawson" <mcgill5@llnl.gov>
License: MIT
License-File: LICENSE
License-File: NOTICE
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: asdf
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scikit-learn
Requires-Dist: scipy
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex; extra == 'docs'
Provides-Extra: test
Requires-Dist: arviz; extra == 'test'
Requires-Dist: dynesty; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# popclass

[![Documentation Status](https://readthedocs.org/projects/popclass/badge/?version=latest)](https://popclass.readthedocs.io/en/latest/?badge=latest) ![Tests](https://github.com/LLNL/popclass/actions/workflows/test.yml/badge.svg) [![codecov](https://codecov.io/gh/LLNL/popclass/graph/badge.svg?token=A4DAAGSE2V)](https://codecov.io/gh/LLNL/popclass) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/LLNL/popclass/main.svg)](https://results.pre-commit.ci/latest/github/LLNL/popclass/main) ![PyPI](https://img.shields.io/pypi/v/popclass?label=pypi%20package) [![conda-forge](https://anaconda.org/conda-forge/popclass/badges/version.svg)](https://anaconda.org/conda-forge/popclass)

popclass is a python package that allows flexible, probabilistic classification of
the lens of a microlensing event given the event's posterior distribution and a model of
the Galaxy. popclass provides the bridge between Galactic simulation and lens classification,
an interface to common Bayesian inference libraries, and the ability for users to flexibly
specify their own Galactic model and classification parameters.

For more details on the project please including the installation, contributing, and the getting started guide see the [documentation](https://popclass.readthedocs.io).

![image info](./docs/images/lens_class.gif)

Example of popclass classifying a microlensing event with a range of different posterior distributions. Left panel shows a population simulation used to classify the event. Right panel shows the output lens classification from popclass which is calculated by combining the event posterior information with the simulation.

## License

popclass is distributed under the terms of the MIT license. All new contributions must be made under the MIT license.

See Link to [license](https://github.com/LLNL/popclass/blob/main/LICENSE) and [NOTICE](https://github.com/LLNL/popclass/blob/main/NOTICE) for details.

SPDX-License-Identifier: MIT

LLNL-CODE-2000456
