diff --git a/docs/source/how_to.md b/docs/source/how_to.md index fb112056..9617c3c3 100644 --- a/docs/source/how_to.md +++ b/docs/source/how_to.md @@ -7,19 +7,19 @@ starting without programming experience). This post is meant to help you with setting up your first experiment, based on the Berlin Emodb. -1) Set up python +1) Set up python -It's written in python, so first you have to set up a Python environment. -It is recommended to use Linux-based systems for easiness, but it should work on Windows as well. +It's written in python, so first you have to set up a Python environment. +It is recommended to use Linux-based systems for easiness, but it should work on Windows as well. The current version of nkululeko is tested with Python 3.8.5. -2) Get a database +2) Get a database Load the Berlin emodb database to some location on you harddrive, as -discussed in this post. I will refer to the location as "emodb root" +discussed in [this post](http://blog.syntheticspeech.de/2021/08/10/get-all-information-from-emodb/). I will refer to the location as "emodb root" from now on. -3) Install nkululeko +3) Install nkululeko Inside your virtual environment, run: @@ -28,7 +28,7 @@ Inside your virtual environment, run: This should install nkululeko and all required modules. It takes a long time and a lot of space, when done intially. -5) Adapt the ini file +5) Adapt the ini file Use your favourite editor, e.g., Visual Studio code and edit the file that defines your experiment. You might start with this demo sample. You @@ -42,7 +42,7 @@ this: An overview on all nkululeko options should be here. -6) Run the experiment +6) Run the experiment Inside a shell type (or use VSC) and start the process with: