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

pip install openterrace

Install in editable mode

1. 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

2. Next, I recommend using Linux or WSL (if on Windows). Inside a linux terminal do:

mkdir -p ~/miniconda3
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
rm -rf ~/miniconda3/miniconda.sh

1. Then, initialise your conda environment:

   ~/miniconda3/bin/conda init bash
   

2. Now, reopen your terminal and create a virtual environment called ot:

conda create -n ot

1. Then activate it:

   conda activate ot
   

2. Install pip inside the ot environment

   conda install pip
   

3. Verify that the right pip version is picked up:

   which pip
   

   which should give you something like /home/[username]/miniconda3/envs/ot/bin/pip

4. Finally, install OpenTerrace inside our virtual environment by navigating to the "openterrace-python" folder and install in editable mode by:

   pip install --editable .
   

5. Verify that the ot virtual environment is picked up in VS Code.

Now you are ready to run tutorials and modify the OpenTerrace like as you like.