phonlab 0.0.47

Python tools for phonetics

phonlab

A collection of python functions for doing phonetics.

Installation and Documentation

• The package includes a yaml file that can be used to create a conda environment with the command:

conda env create --file phonlab_env.yaml

• To install phonlab into an existing environment use pip:

pip install phonlab

• The phonlab documentation is here: https://phonlab.readthedocs.io

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 this repository!

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 phonetics-projects/phonlab repository on github

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