.gif)
Description:
peccary 0.1.1
PECCARY
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) ,
Rosso et al. (2007) ,
and Weck et al. (2015).
This code is also based on work by collaborator David Schaffner, who wrote the initial
version of some of the method, called 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).
If you make use of PECCARY, please include a citation to Hyman, Daniel, & Schaffner (arXiv:2407.11970)
in any publications.
Documentation
The documentation for peccary is hosted on Read the Docs.
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
in the documentation for more instructions.
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
