UCI Phonotactic Calculator

Easily score wordlists with classic and positional-n-gram phonotactic models — right from the command line or a friendly web interface.

✨ What can I do with it?

The output is a CSV that adds phonotactic scores next to each word, ready for Excel or Pandas.

🚀 Quick install

# 1. (Optional) create and activate a virtual environment
python -m venv venv
source venv/bin/activate   # on Windows: venv\Scripts\activate

# 2. Install the core package
pip install uci-phonotactic-calculator

That’s it! If you need the web UI, just add the extra tag:

pip install "uci-phonotactic-calculator[ui]"

🏃 Your first run

# Train on English, score the sample test set, write results to scores.csv
python -m uci_phonotactic_calculator.main data/english.csv \
       data/sample_test_data/english_test_data.csv \
       scores.csv

Don’t have your own data yet? Use the built-in demo corpus:

python -m uci_phonotactic_calculator.main --use-demo-data scores.csv

You’ll get a CSV like:

🖥️ Django interface (optional)

Prefer point-and-click? Fire up the Django web interface:

make django      # or: python -m uci_phonotactic_calculator.web.django.webcalc

A browser window opens where you can drop CSVs, tweak a few options, and download scores.

🖥️ Gradio interface (optional)

Prefer point-and-click? Fire up the Gradio UI:

make web      # or: python -m uci_phonotactic_calculator.web.web_demo

A browser window opens where you can drop CSVs, tweak a few options, and download scores.

📚 Want to go deeper?

• Run python -m uci_phonotactic_calculator.main --help for all flags.
• Developers can install extras with pip install ".[dev]" and check out CONTRIBUTING.md.
• Full docs & citation info: https://phonotactics.socsci.uci.edu/

✏️ Citation

If this tool helps your research, please cite:

Mayer, C., Kondur, A., & Sundara, M. (2022). UCI Phonotactic Calculator (v0.1.0). https://doi.org/10.5281/zenodo.7443706