Metadata-Version: 2.1
Name: avn
Version: 0.3.0
Summary: Package for zebra finch song analysis.
Home-page: https://github.com/theresekoch/avn
License: GNU General Public License v3.0
Author: Therese Koch
Requires-Python: >=3.7.1,<3.10
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: librosa (==0.8.0)
Requires-Dist: matplotlib (>=3.4.1,<4.0.0)
Requires-Dist: more_itertools (>=8.5.0,<9.0.0)
Requires-Dist: numpy (>=1.20.2,<1.21.0)
Requires-Dist: pandas (>=1.3.3)
Requires-Dist: scikit-learn (>=0.24.2,<0.25.0)
Requires-Dist: scipy (>=1.6.3,<2.0.0)
Requires-Dist: seaborn (>=0.11.2,<0.12.0)
Project-URL: Documentation, https://avn.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/theresekoch/avn
Description-Content-Type: text/markdown

# avn 

[![Python](https://img.shields.io/badge/python-3.9-blue)]()
[![codecov](https://codecov.io/gh/theresekoch/avn/branch/main/graph/badge.svg)](https://codecov.io/gh/theresekoch/avn)
[![Documentation Status](https://readthedocs.org/projects/avn/badge/?version=latest)](https://avn.readthedocs.io/en/latest/?badge=latest)

`avn` (Avian Vocalization Network, pronounced 'avian') is a python package for zebra finch song analysis. It currently provides functions
necessary for threshold-based song segmentation into syllables, with plans for more features in the future. 

## Installation

```bash
$ pip install avn
```

## Documentation

The official documentation is hosted on Read the Docs: https://avn.readthedocs.io/en/latest/

## Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/theresekoch/avn/graphs/contributors).

### Credits

This package was created with Cookiecutter and the UBC-MDS/cookiecutter-ubc-mds project template, modified from the [pyOpenSci/cookiecutter-pyopensci](https://github.com/pyOpenSci/cookiecutter-pyopensci) project template and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage).

