Physics distributions for the ClusterKinG package

|Pypi status| |Chat| |License| |Black| |Pre-commit status|

.. |Pypi Status| image:: https://badge.fury.io/py/clusterking_physics.svg :target: https://pypi.org/project/clusterking_physics/ :alt: Pypi

.. |Chat| image:: https://img.shields.io/gitter/room/clusterking/community.svg :target: https://gitter.im/clusterking/community :alt: Gitter

.. |License| image:: https://img.shields.io/github/license/clusterking/clusterking_physics.svg :target: https://github.com/clusterking/clusterking_physics/blob/master/LICENSE.txt :alt: License

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/python/black :alt: Black

.. |Pre-commit status| image:: https://results.pre-commit.ci/badge/github/clusterking/clusterking_physics/master.svg :target: https://results.pre-commit.ci/latest/github/clusterking/clusterking_physics/master :alt: Pre-commit status

Description

This package contains kinematic distributions that can be clustered by the ClusterKinG package <https://github.com/clusterking/clusterking/>_.

Installation

clusterking can be installed/upgraded with the python package installer <https://pip.pypa.io/en/stable/>_:

.. code:: sh

pip3 install --user --upgrade clusterking_physics

For the latest development version type:

.. code:: sh

git clone https://github.com/clusterking/clusterking_physics/
cd clusterking_physics
pip3 install --user --editable .

Development

Similar to that of the ClusterKinG package, see the ClusterKinG documentation <https://clusterking.readthedocs.io/en/latest/development.html>_.