| Name | peccary JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Package for identifying regular, complex, and stochastic behavior in timeseries |
| upload_time | 2024-07-22 18:52:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| 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. |
| keywords |
astrophysics
dynamics
physics
plasma
plasma physics
science
chaos
permutation
entropy
statistical
complexity
peccary
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|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
Raw data
{
"_id": null,
"home_page": null,
"name": "peccary",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "S\u00f3ley Hyman <soleyhyman@arizona.edu>",
"keywords": "astrophysics, dynamics, physics, plasma, plasma physics, science, chaos, permutation, entropy, statistical, complexity, peccary",
"author": null,
"author_email": "S\u00f3ley Hyman <soleyhyman@arizona.edu>",
"download_url": "https://files.pythonhosted.org/packages/bf/50/e69a061282b35ec34d7587034043e2d85426f414753c7c5309f20405c204/peccary-0.1.1.tar.gz",
"platform": null,
"description": "|logo|\n\n*******\nPECCARY\n*******\n|PyPI| |License|\n\nPECCARY (Permutation Entropy and statistiCal Complexity Analysis for astRophYsics) \nis a pure-python package for distinguishing between regular, complex, and stochastic\nbehavior in timeseries. It is based on the work by \n`Bandt & Pompe (2002) <https://ui.adsabs.harvard.edu/#abs/2002PhRvL..88q4102B/abstract>`__ , \n`Rosso et al. (2007) <https://ui.adsabs.harvard.edu/#abs/2007PhRvL..99o4102R/abstract>`__ , \nand `Weck et al. (2015) <https://ui.adsabs.harvard.edu/#abs/2015PhRvE..91b3101W/abstract>`__.\nThis code is also based on work by collaborator David Schaffner, who wrote the initial \nversion of some of the method, called `PESCy <https://github.com/dschaffner/PESCy>`__.\n\nIn addition to calculating the Permutation Entropy ($H$) and Statistical Complexity\n($C$) values, this package also has plotting tools for the $HC$-plane and visualizing the \nresulting $[H,C]$ values for various timeseries.\n\nA detailed summary of the PECCARY method can be found in Hyman, Daniel, & Schaffner (`arXiv:2407.11970 <https://arxiv.org/abs/2407.11970>`__). \nIf you make use of PECCARY, please include a citation to Hyman, Daniel, & Schaffner (`arXiv:2407.11970 <https://arxiv.org/abs/2407.11970>`__)\nin any publications.\n\nDocumentation\n-------------\n|Documentation Status|\n\nThe documentation for ``peccary`` is hosted on `Read the Docs <http://peccary.readthedocs.io>`__.\n\nInstallation and Dependencies\n-----------------------------\n\nThe recommended way to install the latest stable version of ``peccary`` \nis with ``pip`` via the terminal with the command:\n\n>>> pip install peccary\n\nYou can also use the command:\n\n>>> python -m pip install peccary\n\nSee the `installation instructions <https://peccary.readthedocs.io/en/latest/installation.html>`__\nin the `documentation <https://peccary.readthedocs.io>`__ for more instructions.\n\n.. |PyPI| image:: https://badge.fury.io/py/peccary.svg\n :target: https://pypi.org/project/peccary/\n.. |Documentation Status| image:: https://readthedocs.org/projects/peccary/badge/?version=latest\n :target: http://peccary.readthedocs.io/en/latest/?badge=latest\n.. |logo| image:: https://peccary.readthedocs.io/en/latest/_static/peccary-logo-banner.png\n :target: https://github.com/soleyhyman/peccary\n :width: 400\n.. |License| image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat\n :target: https://github.com/soleyhyman/peccary/blob/main/LICENSE\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 S\u00f3ley 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. ",
"summary": "Package for identifying regular, complex, and stochastic behavior in timeseries",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://peccary.readthedocs.io/",
"Issues": "https://github.com/soleyhyman/peccary/issues",
"Repository": "https://github.com/soleyhyman/peccary"
},
"split_keywords": [
"astrophysics",
" dynamics",
" physics",
" plasma",
" plasma physics",
" science",
" chaos",
" permutation",
" entropy",
" statistical",
" complexity",
" peccary"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc98162d7b0247cc9146fc6eaec18da446f5fd03e6153d839f4facd0cc8d0a37",
"md5": "c84c1f0581be7c48e21d742632fcdb4e",
"sha256": "688e456fb079d5e214163630053f97daebb1248f0364f1caef6d10a88cff725e"
},
"downloads": -1,
"filename": "peccary-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c84c1f0581be7c48e21d742632fcdb4e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 35243,
"upload_time": "2024-07-22T18:52:43",
"upload_time_iso_8601": "2024-07-22T18:52:43.833391Z",
"url": "https://files.pythonhosted.org/packages/bc/98/162d7b0247cc9146fc6eaec18da446f5fd03e6153d839f4facd0cc8d0a37/peccary-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf50e69a061282b35ec34d7587034043e2d85426f414753c7c5309f20405c204",
"md5": "6bd0ecc0d0b273e974d501ab69a89c70",
"sha256": "766e715a25f437e46595420f4f1a2d318dcd0e12649f987056507f2536d10cb0"
},
"downloads": -1,
"filename": "peccary-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6bd0ecc0d0b273e974d501ab69a89c70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 830197,
"upload_time": "2024-07-22T18:52:45",
"upload_time_iso_8601": "2024-07-22T18:52:45.426879Z",
"url": "https://files.pythonhosted.org/packages/bf/50/e69a061282b35ec34d7587034043e2d85426f414753c7c5309f20405c204/peccary-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 18:52:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soleyhyman",
"github_project": "peccary",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "peccary"
}
