Skip to main content

PECUZAL automatic embedding of uni- and multivariate time series

Project description

https://travis-ci.org/hkraemer/PECUZAL_python.svg?branch=main https://img.shields.io/badge/docs-dev-blue.svg https://zenodo.org/badge/312547816.svg

PECUZAL Python

We introduce the PECUZAL automatic embedding of time series method for Python. It is solely based on the paper [kraemer2021] (Open Source), where the functionality is explained in detail. Here we give an introduction to its easy usage in three examples. Enjoy Embedding!

icon.png

Getting started

Install from PyPI by simply typing

pip install pecuzal-embedding

in your console.

NOTE

This implementation is not profiled well. We recommend to use the implementation in the Julia language or in Matlab, in order to get fast results, especially in the multivariate case. Moreover, it is well documented and embedded in the DynamicalSystems.jl ecosystem. For instance, the compuations made in the Univariate example and the Multivariate example in this documentation took approximately 800s (approx. 13 mins) and 4700s (approx. 1 hour and 10 mins!), respectively, even when using the econ option in the function call, for an accelerated computation. In the Julia implementation the exact same computation took 4s and 25s, respectively! (running on a 2.8GHz Quad-Core i7, 16GB 1600 MHz DDR3)

Documentation

There is a documentation available including some basic usage examples.

Citing and reference

If you enjoy this tool and find it valuable for your research please cite

[kraemer2021]

Kraemer et al., “A unified and automated approach to attractor reconstruction”, New Journal of Physics 23(3), 033017, 10.1088/1367-2630/abe336, 2021.

or as BiBTeX-entry:

@article{Kraemer2021,
    doi = {10.1088/1367-2630/abe336},
    url = {https://doi.org/10.1088/1367-2630/abe336},
    year = 2021,
    month = {mar},
    publisher = {{IOP} Publishing},
    volume = {23},
    number = {3},
    pages = {033017},
    author = {K H Kraemer and G Datseris and J Kurths and I Z Kiss and J L Ocampo-Espindola and N Marwan},
    title = {A unified and automated approach to attractor reconstruction},
    journal = {New Journal of Physics},
    abstract = {We present a fully automated method for the optimal state space reconstruction from univariate and multivariate time series. The proposed methodology generalizes the time delay embedding procedure by unifying two promising ideas in a symbiotic fashion. Using non-uniform delays allows the successful reconstruction of systems inheriting different time scales. In contrast to the established methods, the minimization of an appropriate cost function determines the embedding dimension without using a threshold parameter. Moreover, the method is capable of detecting stochastic time series and, thus, can handle noise contaminated input without adjusting parameters. The superiority of the proposed method is shown on some paradigmatic models and experimental data from chaotic chemical oscillators.}
}

Licence

This is program is free software and runs under MIT Licence.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pecuzal_embedding-1.3.1.tar.gz (656.2 kB view details)

Uploaded Source

Built Distribution

pecuzal_embedding-1.3.1-py3-none-any.whl (655.1 kB view details)

Uploaded Python 3

File details

Details for the file pecuzal_embedding-1.3.1.tar.gz.

File metadata

  • Download URL: pecuzal_embedding-1.3.1.tar.gz
  • Upload date:
  • Size: 656.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for pecuzal_embedding-1.3.1.tar.gz
Algorithm Hash digest
SHA256 0c2e54f415eb65491dcc85a3d178a816023752f4bf6b5844524373d73f4d79dc
MD5 932b8976f02acb0022811e25476a0001
BLAKE2b-256 543c2801a38341fdf425f43237860a02351585852de11b03730743a272bfb219

See more details on using hashes here.

File details

Details for the file pecuzal_embedding-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: pecuzal_embedding-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 655.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for pecuzal_embedding-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2aaa0838ec1adce3fdcd6df1a82ca4e7f17cca781a573fd08b088a53b2d99cca
MD5 85687cb28f178f7a7dd3c57f25c0f15d
BLAKE2b-256 6f8e9f509989a0138629009ef6b82c81a31b54e8899dfc12315ca0d9026bc9a6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page