Metadata-Version: 2.4
Name: periodicity
Version: 1.0b7
Summary: Useful tools for periodicity analysis in time series data.
Home-page: https://github.com/dioph/periodicity
Author: Eduardo Nunes
Author-email: Eduardo Nunes <dioph@pm.me>
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8, <3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bottleneck
Requires-Dist: celerite2<0.3.3,>=0.2.0
Requires-Dist: emcee>=3.0
Requires-Dist: george
Requires-Dist: matplotlib
Requires-Dist: numpy<2
Requires-Dist: pandas<1.5,>=1.2
Requires-Dist: PyWavelets>=0.5
Requires-Dist: scipy>=1.1
Requires-Dist: tqdm
Requires-Dist: xarray<2022,>=0.20
Provides-Extra: docs
Requires-Dist: jupyter>=1.0; extra == "docs"
Requires-Dist: myst-nb>=0.17; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Provides-Extra: test
Requires-Dist: black==22.3.0; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: isort; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: tox; extra == "test"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# Periodicity

Useful tools for periodicity analysis in time series data.

[![](https://github.com/dioph/periodicity/workflows/CI/badge.svg)](https://github.com/dioph/periodicity/actions?query=branch%3Amaster)
[![PyPI version](https://badge.fury.io/py/periodicity.svg)](https://badge.fury.io/py/periodicity)
[![Downloads](https://pepy.tech/badge/periodicity)](https://pepy.tech/project/periodicity)

__Documentation: https://periodicity.readthedocs.io__

Currently includes:
* Auto-Correlation Function (and other general timeseries utilities!)
* Spectral methods:
    * Lomb-Scargle periodogram
    * Bayesian Lomb-Scargle with linear Trend (soon™)
* Time-frequency methods:
    * Wavelet Transform
    * Hilbert-Huang Transform
    * Composite Spectrum
* Phase-folding methods:
    * String Length
    * Phase Dispersion Minimization
    * Analysis of Variance (soon™)
* Decomposition methods:
    * Empirical Mode Decomposition
    * Local Mean Decomposition
    * Variational Mode Decomposition (soon™)
* Gaussian Processes:
    * `george` implementation
    * `celerite2` implementation
    * `celerite2.theano` implementation

## Installation

The latest version is available to download via PyPI: __`pip install periodicity`__.

Alternatively, you can build the current development version from source by cloning this repo (__`git clone https://github.com/dioph/periodicity.git`__) and running __`pip install ./periodicity`__.

## Development

If you're interested in contributing to periodicity, you can install the development dependencies with __`pip install -e ".[test]"`__.

To automatically test the project (and also check formatting, coverage, etc.), simply run __`tox`__ within the project's directory.
