Skip to main content

Tiny toolbox for time series segmentation

Project description

GitHub Actions Documentation Status PyPI Versions MIT License

Tiny toolbox for time series segmentation.

The toolbox presumes a (univariate or multivariate) time series. For example, consider the following univariate time series:

plot1

Such a time series can then be segmented into distinguishable segments using the toolbox:

plot2

All segments are marked in different colors in the plot. And, finally, these segments can be assigned labels like stationarity:

plot3

Green lines indicate stationary segments of the time series.

Installation

Install the package via pip or clone this repository. To use pip, type:

$ pip install pytseg

Usage

Documentation: https://pytseg.readthedocs.io/en/latest/.

Demo notebooks can be found in the demos/ directory of this repository.

📖 Citation

If you find this code useful in your research, please consider citing:

@misc{pytseg2022,
      author = {Raoul Heese},
      title = {pytseg},
      year = {2022},
      publisher = {GitHub},
      journal = {{GitHub} repository},
      howpublished = {\url{https://github.com/RaoulHeese/pytseg}},
     }

The implemented univariate time series segmentation closely follows:

@article{PhysRevE.69.021108,
         title = {Heuristic segmentation of a nonstationary time series},
         author = {Fukuda, Kensuke and Eugene Stanley, H. and Nunes Amaral, Lu\'{\i}s A.},
         journal = {Phys. Rev. E},
         volume = {69},
         issue = {2},
         pages = {021108},
         numpages = {12},
         year = {2004},
         month = {2},
         publisher = {American Physical Society},
         doi = {10.1103/PhysRevE.69.021108},
         url = {https://link.aps.org/doi/10.1103/PhysRevE.69.021108}
        }

There is no affiliation with the authors of this article.

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

pytseg-0.1.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

pytseg-0.1-py3-none-any.whl (10.0 kB view hashes)

Uploaded Python 3

Supported by

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