Metadata-Version: 2.4
Name: super-slurpy
Version: 0.4.1
Summary: Super SLURPy: Python version of Speech and Language Ultrasound Research Package
Author-email: Pertti Palo <giuthas@gmail.com>
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: av>=17.0.1
Requires-Dist: click>=8.3.3
Requires-Dist: numpy>=2.4.4
Requires-Dist: pillow>=12.2.0
Requires-Dist: pydantic>=2.13.3
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: tqdm>=4.67.3
Provides-Extra: gui
Requires-Dist: matplotlib>=3.10.8; extra == "gui"
Requires-Dist: pyqt6>=6.11.0; extra == "gui"
Requires-Dist: scipy>=1.17.1; extra == "gui"
Dynamic: license-file

# Super SLURPy: Python version of Speech and Language Ultrasound Research Package

This project is a Python port of [SLURP](https://github.com/cathylaporte/SLURP). 

## Installing

- Install the package manager uv: 
  - MacOS/Linux run `curl -LsSf https://astral.sh/uv/install.sh | sh`
  - Windows run `powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"`
  - See [uv](https://docs.astral.sh/uv/#getting-started) for more details.
- On the commandline run `uv tool install super-slurpy`
- Run `slurpy --help` for instructions.
- The package is called `super-slurpy` but the program itself is called just
  `slurpy` for convenience.

## Documentation

- General
  [Documentation](https://giuthas-speech-research-tools.github.io/super_slurpy/)
- For current version and development plans see
[Changelog](https://giuthas-speech-research-tools.github.io/super_slurpy/Changelog)
- [List of
  contributors](https://giuthas-speech-research-tools.github.io/super_slurpy/Contributors)

### Versioning

We use [SemVer](http://semver.org/) for versioning under the rules set out by
[PEP 440](https://www.python.org/dev/peps/pep-0440/) with the additional
understanding that releases before 1.0 (i.e. current releases at time of
writing) have not been tested in any way.

For the versions available, see the [tags on this
repository](https://github.com/giuthas-speech-research-tools/super_slurpy/).

### Copyright and License

BSD-2-Clause license like original SLURP.
