Installation guide
First make sure you have a working installation of Python. If you have never worked with Python before, we recommend installing Miniconda alongside the Visual Studio Code text editor. After selecting Miniconda as the Python interpreter in VS Code, you may now install OpenTerrace using pip:
Install using pip
Install in editable mode
-
If you plan on extending or modifying OpenTerrace, you should install it in editable mode. First, use any git client such as GitHub Desktop to clone the OpenTerrace repository
-
Next, I recommend using Linux or WSL (if on Windows). Inside a linux terminal do:
-
Then, initialise your conda environment:
-
Now, reopen your terminal and create a virtual environment called
ot
: -
Then activate it:
-
Verify that the right pip version is picked up:
which should give you something like/home/[username]/miniconda3/envs/ot/bin/pip
-
Finally, install OpenTerrace inside our virtual environment by navigating to the "openterrace-python" folder and install in editable mode by:
-
Verify that the
ot
virtual environment is picked up as the interpreter in VS Code. -
Now you are ready to run tutorials and modify and extend OpenTerrace as you like.