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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file pytseg-0.1.tar.gz.

File metadata

  • Download URL: pytseg-0.1.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.7

File hashes

Hashes for pytseg-0.1.tar.gz
Algorithm Hash digest
SHA256 805fef7534bfdd8e352bb47284908bab607ace0db6d4b29ac9858057e064f62a
MD5 220b1504a9c8f079aff0e5728b3f79ea
BLAKE2b-256 356ba4e0472b79dbe989040204ce838b4dcee3b16bfd10dca3087ad5e54a9c52

See more details on using hashes here.

File details

Details for the file pytseg-0.1-py3-none-any.whl.

File metadata

  • Download URL: pytseg-0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.7

File hashes

Hashes for pytseg-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fd8fbf26f965ac3751ae9b895490eb0f649be03f1de70ab13b7a3bab4be519fb
MD5 5896e2e7cf941fb2d2d8c2951612142c
BLAKE2b-256 fd02967410b51cbc282b9f2d006602d66fb1336751516993167d8987f5f30d7f

See more details on using hashes here.

Supported by

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