Metadata-Version: 2.4
Name: fasttrackpy
Version: 0.6.1
Summary: A python implementation of FastTrack
Author: Josef Fruehwald, Santiago Barreda
Author-email: Josef Fruehwald <JoFrhwld@gmail.com>, Santiago Barreda <sbarreda@ucdavis.edu>
License-Expression: MIT
Requires-Dist: aligned-textgrid>=0.8.1
Requires-Dist: click>=8.3.1
Requires-Dist: cloudpickle>=3.1.2
Requires-Dist: cloup>=3.0.8
Requires-Dist: filetype>=1.2.0
Requires-Dist: joblib>=1.5.3
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numba>=0.61.0
Requires-Dist: polars>=1.38.1
Requires-Dist: praat-parselmouth>=0.4.7
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: scipy>=1.15.3
Requires-Dist: tqdm>=4.67.3
Requires-Python: >=3.10, <3.14
Project-URL: Homepage, https://fasttrackiverse.github.io/fasttrackpy/
Project-URL: Repository, https://github.com/FastTrackiverse/fasttrackpy
Description-Content-Type: text/markdown

# FastTrackPy
[![PyPI](https://img.shields.io/pypi/v/fasttrackpy)](https://pypi.org/project/fasttrackpy/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fasttrackpy) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fasttrackpy) [![Python CI](https://github.com/JoFrhwld/fasttrackpy/actions/workflows/test-and-run.yml/badge.svg)](https://github.com/JoFrhwld/fasttrackpy/actions/workflows/test-and-run.yml) [![codecov](https://codecov.io/gh/FastTrackiverse/fasttrackpy/graph/badge.svg?token=GOAWY4B5C8)](https://codecov.io/gh/FastTrackiverse/fasttrackpy) [![DOI](https://zenodo.org/badge/580169086.svg)](https://zenodo.org/badge/latestdoi/580169086)


A python implementation of the FastTrack method

## Installation

```bash
pip install fasttrackpy
```

This will make the command line executable `fasttrack` available, along with its subcommands:

- `audio`
- `audio-textgrid`
- `corpus`

## Getting help

For any of the fasttrack subcommands, add the `--help` flag to
print the help info. You can also visit [the docs](https://fasttrackiverse.github.io/fasttrackpy/usage/getting_started.html).

## Usage

For a single audio file containing a vowel-like sound:

```bash
fasttrack audio --file audio.wav \
    --output formants.csv
```

For a paired audio file and textgrid with intervals defining
target audio to process:

```bash
fasttrack audio-textgrid --audio audio.wav \
    --textgrid audio.TextGrid \
    --output formants.csv
```

For a corpus directory of paired audio files and textgrid

```bash
fasttrack corpus --corpus dir/ \
    --output formants.csv
```