Skip to content

GUI tool for establishing the phonological Levenshtein distance

License

Notifications You must be signed in to change notification settings

FelixTheodor/PLD2flex

Repository files navigation

PLD2flex

Description

PLD2flex is a GUI-tool for establishing the phonological Levenshtein distance between phonological word forms. This can apply to pairs of word forms, word forms that are compared to lists of other words, including data bases like CELEX (Reference), if available, and any other combination of word forms. PLD2flex takes written (orthographic) input that is transcribed to a phonological form by means of the BAS services and computes PLD scores on the basis of these. By implication, PLD2flex can be used with any language that is supported by the BAS or for that phonological transcripts are provided.

User Manual

Please refer the User Manual that is part of this repo for further description of use cases, installation trouble shooting and references.

Installation

Easiest way to install the tool is to head over to the releases, and download the file for your OS. Its a zip file that contains the binary as well as the needed folder structure. Unpack all of it to a destination of your choice and run the .exe / binary. (On Windows, you might also allow the execution in the Windows Defender Pop-Up).

How to run the tool from source

1. Install python3.12: https://www.python.org/downloads/

2. Install (ana)conda: https://conda.io/projects/conda/en/latest/index.html

3. Clone this repo, open a new terminal (for Windows: Powershell Prompt) in the main directory of it

-3.1 Create a new env with this command: 'conda create --name PLD2flex python=3.12'

-3.2 Activate the new environment: 'conda activate PLD2flex'

-3.3 Install pip in your new environment: 'conda install pip'

4. Install all required packages via pip:

'pip install -r requirements.txt'

5. Update the config.txt

(see section 2.2 of User Guide) For instance, you need to specify the paths for the result / database files. Make sure that you use the right path format for your operating system.

6. Run the main.py:

'python main.py'

Installation Troubleshooting

General:

  • usage of conda is recommended
  • make sure that you use python >=v3.12
  • depending on your system config, you might need to install qt 5.15: https://www.qt.io/offline-installers
  • should the installation of a package fail, try to install the missing_package manually via pip: 'pip install missing_package'

For macOS users:

  • you might need to install another package: 'pip install PyObjC'

For windows users:

Usage

For further information how to use the program, consider the User-Manual in this repo.

About

GUI tool for establishing the phonological Levenshtein distance

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages