Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 1.76 KB

INSTALL.rst

File metadata and controls

58 lines (33 loc) · 1.76 KB

Install procedure

Wavelet Prosody Analyzer is a toolkit comprising command line tools and a GUI application. All the tools are started from terminal, so some familiarity with command line tools is assumed.

Installation has been tested only on one Ubuntu Linux, on Arch Linux and on MacOS Sierra machine. Running on windows might be possible if the required libraries can be installed.

Default installation

To install the toolkit, simply run

pip install -e .[gui]

It will install the dependencies needed to run the toolkit.

To be able to run the application globally, the following line should be added to your shell profile file (~/.bashrc or ~/.profile in general):

export PATH=~/.local/bin:$PATH

After restarting the shell, you can finally run the tool by calling them on the command line, like for example:

wavelet_gui

Development mode installation

Even if the setup doesn't require it, we advise to use the environment management system conda ( https://docs.conda.io/en/latest/miniconda.html ). Conda provides an easy way to define the environments and install precompiled packages. Therefore, the modification you will propose won't affect your system configuration.

Assuming you have created activated the conda environment, you can install pre-compiled packages

conda install scipy numpy matplotlib joblib pyqt

We then use the setup script to install the rest of the dependencies:

pip install -e .[full]

To start the Wavelet Prosody Analyzer GUI, run the following commands:

wavelet_gui

if it doesn’t work, please raise an issue on github here: https://github.com/asuni/wavelet_prosody_toolkit/issues .