Skip to main content

phonlab

A collection of python functions for doing phonetics.

Installation and Documentation

  • To install phonlab into an existing environment use pip:

pip install phonlab
conda env create --file phonlab_env.yaml

Examples

See the Phonlab Workshop slide deck for some background on this package. There are example jupyter notebooks in the google drive linked in those slides.

See also the examples folder in the github repository!

Testing

To run the unit tests:

pip install pytest
python -m pytest test/ -v

Contributing

We solicit contributions/corrections from the research community. Here are some steps you can follow to contribute to this project.

  1. Open a new issue in the https://github.com/phonetics-projects/phonlab repository.

  2. Use git to Clone the repository.

  3. Make your changes on your local clone of the repository

    • if you are adding a function, add it to the repository in a separate file, and write a good doc string for it

    • if you are correcting or extending an existing function, modify the existing file

  4. If you are adding a function, also do these things:

    • edit the __init__.pyi file to include your file in the package, following the examples in that file.

    • edit the appropriate .rst file in the docs/source folder to include your function in the package documentation.

  5. If your change requires a new python package, update the pyproject.toml and phonlab_env.yaml files to include the dependency.

  6. Add/Commit your changes (preferably one commit per change rather than a set of unrelated changes in one big commit).

  7. Push to your clone of the repository on github

  8. Issue a pull request to add your change to the phonetics-projects/phonlab repository

    • the changes will be reviewed before they become part of the published repository

Release files for phonlab 0.0.60

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for phonlab 0.0.60
File Size Uploaded
phonlab-0.0.60.tar.gz 9.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for phonlab 0.0.60
File Interpreter ABI Platform
phonlab-0.0.60-py3-none-any.whl Python 3 none any Details

Total release size: 19.1 MB

Release files / phonlab-0.0.60.tar.gz

Download URL phonlab-0.0.60.tar.gz
Size 9.5 MB
Tags Source
SHA-256 checksum
How to use checksums
d07c7ebfb330294c29f75ea6c8c382d0b12b9b2b08e994b7d0168ba1523d63c2
BLAKE2b-256 checksum
How to use checksums
1380eef05bd3bf5478ba5fb69af0303f56825e7e20fa6d5554d2f85c38d0a9e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.18

Release files / phonlab-0.0.60-py3-none-any.whl

Download URL phonlab-0.0.60-py3-none-any.whl
Size 9.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
eb925c20dec38e70e66782c0864f49a0a317c879d5be8705f8f46dcc2c3942ad
BLAKE2b-256 checksum
How to use checksums
f6c5ae9dc7d4476a1d4fc9398101c3006668a8dc0dcc5d27af459ad7b670e2ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.18
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page