Metadata-Version: 2.1
Name: vocalpy
Version: 0.2.0.post1
Summary: Core package for acoustic communication in Python
Author-email: David Nicholson <nickledave@users.noreply.github.com>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Dist: attrs >=23.1.0
Requires-Dist: crowsetta >=5.0.0
Requires-Dist: dask >=2.10.1
Requires-Dist: evfuncs >= 0.3.3
Requires-Dist: librosa >= 0.10.0.post2
Requires-Dist: numpy >=1.21.0
Requires-Dist: pandas >= 1.3.5
Requires-Dist: scipy >=1.7.0
Requires-Dist: SoundFile >=0.12.1
Requires-Dist: SQLAlchemy >=2.0.12
Requires-Dist: twine >=3.7.1 ; extra == "dev"
Requires-Dist: black >=21.12b0 ; extra == "dev"
Requires-Dist: ipython >=8.0.0 ; extra == "dev"
Requires-Dist: nox >= 2022.1.7 ; extra == "dev"
Requires-Dist: vocalpy[doc, test] ; extra == "dev"
Requires-Dist: ipython != 8.7.0 ; extra == "doc"
Requires-Dist: jupyterlab >=3.0.3 ; extra == "doc"
Requires-Dist: jupytext >=1.13.8 ; extra == "doc"
Requires-Dist: myst-nb >=0.15.0 ; extra == "doc"
Requires-Dist: sphinx >=4.4.0 ; extra == "doc"
Requires-Dist: pytest >=6.2.5 ; extra == "test"
Requires-Dist: pytest-cov >=2.11.1 ; extra == "test"
Requires-Dist: pytest-xdist >=3.2.0 ; extra == "test"
Project-URL: Home, https://github.com/NickleDave/vocalpy
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test

<br>
<div align="center">
<img src="https://github.com/vocalpy/vocalpy/blob/main/docs/_static/vocalpy-primary.png?raw=True" width="400">
</div>
<hr>

## A core package for acoustic communication research in Python

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Build Status](https://github.com/vocalpy/vocalpy/actions/workflows/ci.yml/badge.svg)](https://github.com/vocalpy/vocalpy/actions)
[![Documentation Status](https://readthedocs.org/projects/vocalpy/badge/?version=latest)](https://vocalpy.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/159904494.svg)](https://zenodo.org/badge/latestdoi/159904494)
[![PyPI version](https://badge.fury.io/py/vocalpy.svg)](https://badge.fury.io/py/vocalpy)
[![PyPI Python versions](https://img.shields.io/pypi/pyversions/vocalpy)](https://img.shields.io/pypi/pyversions/vocalpy)
[![codecov](https://codecov.io/gh/vocalpy/vocalpy/branch/main/graph/badge.svg?token=TXtNTxXKmb)](https://codecov.io/gh/vocalpy/vocalpy)

goal: a core package for acoustic communication research in Python;
a community effort to develop and to foster an ecosystem of interoperable packages.

model: `astropy`
* focus on interoperability, modularity + composability, open standards
    * https://docs.astropy.org/en/latest/development/vision.html
    * https://www.aanda.org/articles/aa/abs/2013/10/aa22068-13/aa22068-13.html
    * https://arxiv.org/abs/1610.03159
    * https://iopscience.iop.org/article/10.3847/1538-3881/aabc4f/meta

Currently a proof-of-concept Work in Progress; in development, contributors are more than welcome.

## Getting Started
### Installation
#### with `pip`

```console
$ pip install vocalpy
```

#### with `conda`

```console
$ conda install vocalpy -c conda-forge
```

### Support

To report a bug or request a feature (such as a new annotation format), 
please use the issue tracker on GitHub:  
<https://github.com/vocalpy/vocalpy/issues>

To ask a question about vocalpy, discuss its development, 
or share how you are using it, 
please start a new topic on the VocalPy forum 
with the vocalpy tag:  
<https://forum.vocalpy.org/>

### Contribute

#### Code of conduct

Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.

#### Contributing Guidelines

Below we provide some quick links, 
but you can learn more about how you can help and give feedback  
by reading our [Contributing Guide](./CONTRIBUTING.md).

To ask a question about vocalpy, discuss its development, 
or share how you are using it, 
please start a new "Q&A" topic on the VocalPy forum 
with the vocalpy tag:  
<https://forum.vocalpy.org/>

To report a bug, or to request a feature, 
please use the issue tracker on GitHub:  
<https://github.com/vocalpy/vocalpy/issues>

### CHANGELOG
You can see project history and work in progress in the [CHANGELOG](./docs/CHANGELOG.md)

### License

The project is licensed under the [BSD license](./LICENSE).

### Citation
If you use vocalpy, please cite the DOI:
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7905426.svg)](https://doi.org/10.5281/zenodo.7905426)


