Metadata-Version: 2.4
Name: voxatlas
Version: 0.1.0
Summary: Modular feature extraction toolkit for conversational speech
Author: Your Name
License: MIT
Keywords: speech,phonetics,linguistics,feature extraction,conversation analysis
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: soundfile
Provides-Extra: acoustic
Requires-Dist: librosa; extra == "acoustic"
Requires-Dist: parselmouth; extra == "acoustic"
Provides-Extra: syntax
Requires-Dist: spacy; extra == "syntax"
Provides-Extra: semantics
Requires-Dist: transformers; extra == "semantics"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: numpydoc; extra == "dev"
Requires-Dist: pydata-sphinx-theme; extra == "dev"
Requires-Dist: sphinx-copybutton; extra == "dev"
Requires-Dist: sphinx-design; extra == "dev"

# VoxAtlas

VoxAtlas is a modular Python toolkit for feature extraction and analysis workflows.

## Documentation

The project includes a Sphinx documentation setup styled after MNE-Python and NumPy conventions:

- NumPy-style docstrings
- API documentation generated from Python docstrings
- autosummary-based API tables
- `pydata-sphinx-theme`
- `numpydoc` formatting

Build the documentation from the repository root:

```bash
pip install -r docs/requirements.txt
cd docs
make html
```

The generated site is written to:

```text
docs/_build/html/index.html
```

## Docstring Guidelines

Public API docstrings should follow NumPy style and include:

- `Parameters`
- `Returns`
- `Notes` when useful
- `Usage example` for public API functions, classes, and methods

Example:

```python
def compute_trf(signal: np.ndarray, stimulus: np.ndarray) -> np.ndarray:
    """
    Compute temporal response function.

    Parameters
    ----------
    signal : ndarray
        Neural signal time series.
    stimulus : ndarray
        Stimulus feature matrix.

    Returns
    -------
    ndarray
        TRF kernel.

    Notes
    -----
    Used for speech-brain alignment analyses.

    Usage example
    -------------
        kernel = compute_trf(signal, stimulus)
    """
```
