Metadata-Version: 2.1
Name: peccary
Version: 0.1.1
Summary: Package for identifying regular, complex, and stochastic behavior in timeseries
Author-email: Sóley Hyman <soleyhyman@arizona.edu>
Maintainer-email: Sóley Hyman <soleyhyman@arizona.edu>
License: MIT License
        
        Copyright (c) 2024 Sóley Hyman
        
        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.
        
Project-URL: Documentation, https://peccary.readthedocs.io/
Project-URL: Repository, https://github.com/soleyhyman/peccary
Project-URL: Issues, https://github.com/soleyhyman/peccary/issues
Keywords: astrophysics,dynamics,physics,plasma,plasma physics,science,chaos,permutation,entropy,statistical,complexity,peccary
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy >=1.14
Requires-Dist: scipy >=0.19
Requires-Dist: matplotlib

|logo|

*******
PECCARY
*******
|PyPI| |License|

PECCARY (Permutation Entropy and statistiCal Complexity Analysis for astRophYsics) 
is a pure-python package for distinguishing between regular, complex, and stochastic
behavior in timeseries. It is based on the work by 
`Bandt & Pompe (2002) <https://ui.adsabs.harvard.edu/#abs/2002PhRvL..88q4102B/abstract>`__ , 
`Rosso et al. (2007) <https://ui.adsabs.harvard.edu/#abs/2007PhRvL..99o4102R/abstract>`__ , 
and `Weck et al. (2015) <https://ui.adsabs.harvard.edu/#abs/2015PhRvE..91b3101W/abstract>`__.
This code is also based on work by collaborator David Schaffner, who wrote the initial 
version of some of the method, called `PESCy <https://github.com/dschaffner/PESCy>`__.

In addition to calculating the Permutation Entropy ($H$) and Statistical Complexity
($C$) values, this package also has plotting tools for the $HC$-plane and visualizing the 
resulting $[H,C]$ values for various timeseries.

A detailed summary of the PECCARY method can be found in Hyman, Daniel, & Schaffner (`arXiv:2407.11970 <https://arxiv.org/abs/2407.11970>`__). 
If you make use of PECCARY, please include a citation to Hyman, Daniel, & Schaffner (`arXiv:2407.11970 <https://arxiv.org/abs/2407.11970>`__)
in any publications.

Documentation
-------------
|Documentation Status|

The documentation for ``peccary`` is hosted on `Read the Docs <http://peccary.readthedocs.io>`__.

Installation and Dependencies
-----------------------------

The recommended way to install the latest stable version of ``peccary`` 
is with ``pip`` via the terminal with the command:

>>> pip install peccary

You can also use the command:

>>> python -m pip install peccary

See the `installation instructions <https://peccary.readthedocs.io/en/latest/installation.html>`__
in the `documentation <https://peccary.readthedocs.io>`__ for more instructions.

.. |PyPI| image:: https://badge.fury.io/py/peccary.svg
   :target: https://pypi.org/project/peccary/
.. |Documentation Status| image:: https://readthedocs.org/projects/peccary/badge/?version=latest
   :target: http://peccary.readthedocs.io/en/latest/?badge=latest
.. |logo| image:: https://peccary.readthedocs.io/en/latest/_static/peccary-logo-banner.png
   :target: https://github.com/soleyhyman/peccary
   :width: 400
.. |License| image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
   :target: https://github.com/soleyhyman/peccary/blob/main/LICENSE
