Metadata-Version: 2.1
Name: zigzag
Version: 0.3.2
Summary: Package for finding peaks and valleys of time series.
Home-page: https://github.com/jbn/ZigZag
License: BSD-3-Clause
Author: generativist
Author-email: jbn@abreka.com
Requires-Python: >=3.8
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Cython (>=0.29,<0.30)
Requires-Dist: numpy (>=1.21.1)
Project-URL: Repository, https://github.com/jbn/ZigZag
Description-Content-Type: text/markdown

![build-and-test-python](https://github.com/jbn/ZigZag/actions/workflows/build-and-test-python.yml/badge.svg)
[![PyPI version](https://badge.fury.io/py/ZigZag.svg)](https://badge.fury.io/py/ZigZag)
[![GitHub stars](https://img.shields.io/github/stars/jbn/ZigZag)](https://github.com/jbn/ZigZag/stargazers)
[![GitHub license](https://img.shields.io/github/license/jbn/ZigZag)](https://github.com/jbn/ZigZag/blob/main/LICENSE.txt)
![PyPI - Downloads](https://img.shields.io/pypi/dm/ZigZag)


# ZigZag

ZigZag provides functions for identifying the peaks and valleys of a time
series. Additionally, it provides a function for computing the maximum drawdown.

For fastest understanding, [view the IPython notebook demo tutorial](https://github.com/jbn/ZigZag/blob/master/zigzag_demo.ipynb>).

## Contributing

This is an admittedly small project. Still, if you have any contributions, 
please [fork this project on github](https://github.com/jbn/ZigZag) and
send me a pull request.

