antiCPy


NameantiCPy JSON
Version 0.0.8.post1 PyPI version JSON
download
home_pagehttps://github.com/MartinHessler/antiCPy
SummaryA package that provides tools to estimate resilience and noise level of a system as well as extrapolate possible transition times.
upload_time2024-04-12 06:45:16
maintainerNone
docs_urlNone
authorMartin Heßler
requires_pythonNone
licenseGPL
keywords time series analysis critical transitions leading indicators
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            The `antiCPy` package provides tools to monitor destabilization because of varying control parameters or the influence of noise. Based on early warning measures it provides an extrapolation tool to estimate the time horizon in which a critical transition will probably occur.<br /><br />[![DOI](https://zenodo.org/badge/440811484.svg)](https://zenodo.org/badge/latestdoi/440811484) [![Documentation Status](https://readthedocs.org/projects/anticpy/badge/?version=latest)](https://anticpy.readthedocs.io/en/latest/?badge=latest) [![PyPI version](https://badge.fury.io/py/antiCPy.svg)](https://badge.fury.io/py/antiCPy) [![GitHub release](https://img.shields.io/github/release/MartinHessler/antiCPy?color)](https://github.com/MartinHessler/antiCPy) [![license](https://img.shields.io/github/license/MartinHessler/antiCPy?color=blue)](https://img.shields.io/github/MartinHessler/antiCPy/blob/main/LICENSE)

antiCPy
=======

The package abbreviation **antiCPy** stands for ''**anti**cipate **C**ritical **P**oints (and if you like **C**hange **P**oints) 
with **Py**thon''. The vision of the **antiCPy** package is designing a package collection of state-of-the-art
early warning measures, leading indicators and time series analysis tools that focus on system stability and
resilience in general as well as algorithms that might be helpful to estimate time horizons of future transitions or resilience changes.
It provides an easy applicable and efficient toolbox

1. to estimate the drift slope $\hat{\zeta}$ of a polynomial Langevin equation as an early warning signal via Markov Chain Monte Carlo
   (MCMC) sampling or maximum posterior (MAP) estimation,
2. to estimate a non-Markovian two-time scale polynomial system via MCMC or MAP with the option of a priori activated time scale separation,
3. to estimate the dominant eigenvalue by empiric dynamic modelling approaches like delay embedding and shadow manifolds combined with
   iterated map's linear stability formalism,
4. extrapolate an early warning signal trend to find the probable transition horizon based on the current data information.

Computationally expensive algorithms are implemented both, serially and strongly parallelized to minimize computation times. In case of
the change point trend extrapolation it involves furthermore algorithms that allow for computing of complicated fits with high numbers
of change points without memory errors.
The package aims to provide easily applicable methods and guarantee high flexibility and access to the derived interim results
for research purposes.

![An illustration of the drift slope procedure.](https://github.com/MartinHessler/antiCPy/blob/main/images/compound_BLE_illustration.jpg?raw=true)

Citing antiCPy
==============

If you use **antiCPy's** `drift_slope` measure, please cite

Martin Heßler et al. Bayesian on-line anticipation of critical transitions. New J. Phys. (2022). https://doi.org/10.1088/1367-2630/ac46d4.

If you use **antiCPy's** `dominant_eigenvalue` instead, please cite

Martin Heßler et al. Anticipation of Oligocene's climate heartbeat by simplified eigenvalue estimation.
arXiv (2023). https://doi.org/10.48550/arXiv.2309.14179

Documentation
=============

You can find the [documentation on read the docs](https://anticpy.readthedocs.io/en/latest/).

Install
=======

The package can be installed via

```
pip install antiCPy
```

Related publications
====================
Up to now the package is accompanied by
- the publication [Efficient Multi-Change Point Analysis to Decode Economic Crisis Information from the S&P500 Mean Market Correlation](https://www.mdpi.com/1099-4300/25/9/1265),
- the publication [Memory Effects, Multiple Time Scales and Local Stability in Langevin Models of the S&P500 Market Correlation](https://www.mdpi.com/1099-4300/25/9/1257),
- the publication [Identifying dominant industrial sectors in market states of the S&P 500 financial data](https://iopscience.iop.org/article/10.1088/1742-5468/accce0),
- the publication [Quantifying resilience and the risk of regime shifts under strong correlated noise](https://academic.oup.com/pnasnexus/article/2/2/pgac296/6960580),
- the publication [Bayesian on-line anticipation of critical transitions](https://iopscience.iop.org/article/10.1088/1367-2630/ac46d4),

- the preprint [Anticipation of Oligocene's climate heartbeat by simplified eigenvalue estimation](https://arxiv.org/abs/2309.14179),
- the preprint [Quantifying Tipping Risks in Power Grids and beyond](https://arxiv.org/abs/2212.06780).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MartinHessler/antiCPy",
    "name": "antiCPy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "time series analysis, critical transitions, leading indicators",
    "author": "Martin He\u00dfler",
    "author_email": "m_hess23@wwu.de",
    "download_url": "https://files.pythonhosted.org/packages/37/3b/607d3f70719d6eac4e6e83bc1348e996998bc20d51bcf66ba3c2ed762d38/antiCPy-0.0.8.post1.tar.gz",
    "platform": "any",
    "description": "The `antiCPy` package provides tools to monitor destabilization because of varying control parameters or the influence of noise. Based on early warning measures it provides an extrapolation tool to estimate the time horizon in which a critical transition will probably occur.<br /><br />[![DOI](https://zenodo.org/badge/440811484.svg)](https://zenodo.org/badge/latestdoi/440811484) [![Documentation Status](https://readthedocs.org/projects/anticpy/badge/?version=latest)](https://anticpy.readthedocs.io/en/latest/?badge=latest) [![PyPI version](https://badge.fury.io/py/antiCPy.svg)](https://badge.fury.io/py/antiCPy) [![GitHub release](https://img.shields.io/github/release/MartinHessler/antiCPy?color)](https://github.com/MartinHessler/antiCPy) [![license](https://img.shields.io/github/license/MartinHessler/antiCPy?color=blue)](https://img.shields.io/github/MartinHessler/antiCPy/blob/main/LICENSE)\n\nantiCPy\n=======\n\nThe package abbreviation **antiCPy** stands for ''**anti**cipate **C**ritical **P**oints (and if you like **C**hange **P**oints) \nwith **Py**thon''. The vision of the **antiCPy** package is designing a package collection of state-of-the-art\nearly warning measures, leading indicators and time series analysis tools that focus on system stability and\nresilience in general as well as algorithms that might be helpful to estimate time horizons of future transitions or resilience changes.\nIt provides an easy applicable and efficient toolbox\n\n1. to estimate the drift slope $\\hat{\\zeta}$ of a polynomial Langevin equation as an early warning signal via Markov Chain Monte Carlo\n   (MCMC) sampling or maximum posterior (MAP) estimation,\n2. to estimate a non-Markovian two-time scale polynomial system via MCMC or MAP with the option of a priori activated time scale separation,\n3. to estimate the dominant eigenvalue by empiric dynamic modelling approaches like delay embedding and shadow manifolds combined with\n   iterated map's linear stability formalism,\n4. extrapolate an early warning signal trend to find the probable transition horizon based on the current data information.\n\nComputationally expensive algorithms are implemented both, serially and strongly parallelized to minimize computation times. In case of\nthe change point trend extrapolation it involves furthermore algorithms that allow for computing of complicated fits with high numbers\nof change points without memory errors.\nThe package aims to provide easily applicable methods and guarantee high flexibility and access to the derived interim results\nfor research purposes.\n\n![An illustration of the drift slope procedure.](https://github.com/MartinHessler/antiCPy/blob/main/images/compound_BLE_illustration.jpg?raw=true)\n\nCiting antiCPy\n==============\n\nIf you use **antiCPy's** `drift_slope` measure, please cite\n\nMartin He\u00dfler et al. Bayesian on-line anticipation of critical transitions. New J. Phys. (2022). https://doi.org/10.1088/1367-2630/ac46d4.\n\nIf you use **antiCPy's** `dominant_eigenvalue` instead, please cite\n\nMartin He\u00dfler et al. Anticipation of Oligocene's climate heartbeat by simplified eigenvalue estimation.\narXiv (2023). https://doi.org/10.48550/arXiv.2309.14179\n\nDocumentation\n=============\n\nYou can find the [documentation on read the docs](https://anticpy.readthedocs.io/en/latest/).\n\nInstall\n=======\n\nThe package can be installed via\n\n```\npip install antiCPy\n```\n\nRelated publications\n====================\nUp to now the package is accompanied by\n- the publication [Efficient Multi-Change Point Analysis to Decode Economic Crisis Information from the S&P500 Mean Market Correlation](https://www.mdpi.com/1099-4300/25/9/1265),\n- the publication [Memory Effects, Multiple Time Scales and Local Stability in Langevin Models of the S&P500 Market Correlation](https://www.mdpi.com/1099-4300/25/9/1257),\n- the publication [Identifying dominant industrial sectors in market states of the S&P 500 financial data](https://iopscience.iop.org/article/10.1088/1742-5468/accce0),\n- the publication [Quantifying resilience and the risk of regime shifts under strong correlated noise](https://academic.oup.com/pnasnexus/article/2/2/pgac296/6960580),\n- the publication [Bayesian on-line anticipation of critical transitions](https://iopscience.iop.org/article/10.1088/1367-2630/ac46d4),\n\n- the preprint [Anticipation of Oligocene's climate heartbeat by simplified eigenvalue estimation](https://arxiv.org/abs/2309.14179),\n- the preprint [Quantifying Tipping Risks in Power Grids and beyond](https://arxiv.org/abs/2212.06780).\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "A package that provides tools to estimate resilience and noise level of a system as well as extrapolate possible transition times.",
    "version": "0.0.8.post1",
    "project_urls": {
        "Homepage": "https://github.com/MartinHessler/antiCPy"
    },
    "split_keywords": [
        "time series analysis",
        " critical transitions",
        " leading indicators"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "373b607d3f70719d6eac4e6e83bc1348e996998bc20d51bcf66ba3c2ed762d38",
                "md5": "8656795c1e884b04da4528c8c5b0e60a",
                "sha256": "f67f918ad4ffd5b100d9d3ef701604541f7b68ce6c0657b56867e1139f525a52"
            },
            "downloads": -1,
            "filename": "antiCPy-0.0.8.post1.tar.gz",
            "has_sig": false,
            "md5_digest": "8656795c1e884b04da4528c8c5b0e60a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 77975,
            "upload_time": "2024-04-12T06:45:16",
            "upload_time_iso_8601": "2024-04-12T06:45:16.948954Z",
            "url": "https://files.pythonhosted.org/packages/37/3b/607d3f70719d6eac4e6e83bc1348e996998bc20d51bcf66ba3c2ed762d38/antiCPy-0.0.8.post1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-12 06:45:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MartinHessler",
    "github_project": "antiCPy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "anticpy"
}
        
Elapsed time: 0.22872s