Metadata-Version: 2.3
Name: maui-software
Version: 0.2.2
Summary: Eco-acoustics data visualization and analysis
Author: Caio Ferreira Bernardo
Author-email: caio.bernardo@usp.br
Requires-Python: >=3.9,<3.13
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: audioread (>=3.0.0,<4.0.0)
Requires-Dist: fastparquet (>=2024.5.0,<2025.0.0)
Requires-Dist: fpdf (>=1.7.2,<2.0.0)
Requires-Dist: gdown (>=5.2.0,<6.0.0)
Requires-Dist: kaleido (==0.2.1)
Requires-Dist: matplotlib (>=3.8.3,<4.0.0)
Requires-Dist: numpy (>=1.21)
Requires-Dist: objgraph (>=3.6.1,<4.0.0)
Requires-Dist: pandas (>=1.5)
Requires-Dist: plotly (>=5.16.1,<6.0.0)
Requires-Dist: pyarrow (>=17.0.0,<18.0.0)
Requires-Dist: pydub (>=0.25.1,<0.26.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: scikit-maad (>=1.3.0,<2.0.0)
Requires-Dist: tqdm (>=4.66.1,<5.0.0)
Description-Content-Type: text/markdown

    
# maui-software

![maui-softwre logo](maui/data/logo/color_logo_no_background.png "maui-software logo")

**maui-software** is an open-source Python package to visualize eco-acoustic data. This work intends to help ecology specialists to perform data analysis with no need to implement visualizations, enabling faster analysis.

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#active)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2fda82e1f9cd459eb38a78674c544031)](https://app.codacy.com/gh/maui-software/maui-software/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/2fda82e1f9cd459eb38a78674c544031)](https://app.codacy.com/gh/maui-software/maui-software/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)

# Operating Systems

`maui-software` was tested on the following operating systems:

  - Windows
  - Ubuntu


# Dependencies

  - python = >=3.9,<3.13
  - scikit-maad = ^1.3.0
  - plotly = ^5.16.1
  - tqdm = ^4.66.1
  - fpdf = ^1.7.2
  - audioread = ^3.0.0
  - pandas = >=1.5
  - numpy = >= 1.21
  - kaleido = 0.2.1
  - pyyaml = ^6.0.1
  - matplotlib = ^3.8.3
  - gdown = ^5.2.0
  - pydub = ^0.25.1
  - objgraph = ^3.6.1
  - pyarrow = ^17.0.0
  - fastparquet = ^2024.5.0
  - pypalettes = ^0.1.3

# Installation

```bash
$ pip install maui-software
```

# Quick Start

To use `maui-software`, one must have a single audio file or, preferencially, a set of audio files and load them as follows:

```python
from maui import io
audio_dir = 'PATH_TO_DIRECTORY'
df = io.get_audio_info(audio_dir, store_duration=1, perc_sample=0.01)

df
```

# Acknowledgements

Special thanks to the spatial ecology and conservation laboratory
(LEEC, in portuguese) at São Paulo State University (UNESP, in portuguese)
for the data set provided and expert support.

Also, `maui-software` uses `scikit-maad` to calculate
acoustic indices and spectrograms from audio. 
We finally acknowledge the financial support of FAPESP
(The State of São Paulo Research Foundation) Grant # 2021/08322-3.

