Metadata-Version: 2.4
Name: zigzag-dt
Version: 0.4.2
Summary: Package for finding peaks and valleys in array or series.
Author-email: generativist <jbn@abreka.com>, Alex & Claude <python@iitsp.com.au>
Maintainer-email: Alex & Claude <python@iitsp.com.au>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/Alex-Glebov/ZigZag
Project-URL: Documentation, https://github.com/Alex-Glebov/ZigZag
Project-URL: Issues, https://github.com/Alex-Glebov/ZigZag/issues
Project-URL: repository, https://github.com/Alex-Glebov/ZigZag
Project-URL: Changelog, https://github.com/Alex-Glebov/ZigZag/CHANGELOG.md
Project-URL: Repository, https://github.com/Alex-Glebov/ZigZag.git
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy>=1.21.1
Requires-Dist: pandas>=2.3.1
Provides-Extra: cli
Requires-Dist: matplotlib>=3.10.6; extra == "cli"
Dynamic: license-file

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


# zigzag-dt

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

Install with pip:

```bash
pip install zigzag-dt
```

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

## API Aliases

To avoid name collisions with other zigzag packages, all main functions are also
exposed with a `zz_` prefix:

```python
from zigzag_dt import zz_pivots, zz_line, zz_max_drawdown
```

## Contributing

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