PiVR has been developed by David Tadres and Matthieu Louis (Louis Lab).

9. PiVR software installation¶

9.1. Install PiVR on the Raspberry Pi¶

The easiest way to install PiVR on your Raspberry Pi is to just follow the instructions during hardware construction.

If you just want to download the installation script to your Raspberry Pi, press here

Open the terminal. Then change directory to the ‘Downloads’ folder (or wherever you downloaded the file) and type:

bash install_PiVR.sh

9.2. Install PiVR on a PC¶

Install miniconda on your computer.
Install git on your computer

Note

If you have Windows, you may try this guide which will install the software more or less automatically.

Note

If you have Ubuntu, you may try this guide which will install the software more or less automatically.

Now, create an empty conda environment:
```
conda create --name PiVR_environment
```
Activate the environment you just created by typing:

Linux/Mac:
```
source activate PiVR_environment
```
Windows:
```
activate PiVR_environment
```

Install the a number of packages which are necessary to run the PiVR software by copying each line of code into the Terminal

conda install -y imageio=2.9.0

conda install -y matplotlib

conda install -y pandas

conda install -y scipy

conda install -y natsort

conda install -y scikit-image

conda install -c conda-forge opencv -y

Windows/Linux:
conda install -c conda-forge imageio-ffmpeg

MacOS:
conda install -c conda-forge ffmpeg

You have now prepared the virtual environment PiVR will be running in.
Using the anaconda terminal, change the working directory to a folder where you want to store the actual PiVR software.
cd C:\Users\UserA\Documents>
Note

You might want to write down the exact path so that you will find it again in the future!

Download the software by typing:

git clone https://gitlab.com/louislab/PiVR

Now navigate into the folder you have just downloaded by typing:
```
cd PiVR
```
To start the PiVR software type:
```
python start_GUI.py
```

9.3. Install PiVR on a Windows 10 PC¶

Important

If you are having trouble with this installation procedure, do the manual install.

Warning

Only Win10, 64bit tested!

Open the Anaconda prompt
Navigate into a folder where you want to store the PiVR software, for example:
```
cd C:\Users\UserA\Documents>
```

Download the software by typing:

git clone https://gitlab.com/louislab/PiVR

Navigate into the installation folder by typing:
```
cd PiVR\Installation_update
```
Create the Windows 10 virtual environment for the PiVR software to run using the provided package list by typing:
```
conda create --name PiVR_environment --file PiVR_Win64.txt
```
Once done, activate the virtual environment by typing:
```
activate PiVR_environment
```
You know you successfully activated the virtual enviroment if it says ‘(PiVR)’ at the beginnig of the line in the terminal.
Start the software by going into the folder where the file “start_GUI.py” can be found, which is the parent folder of the installation folder you should be in now. So just type:
```
cd ..
```
And to finally start PiVR, type:
```
python start_GUI.py
```

9.4. Install PiVR on a Linux PC¶

Important

If you are having trouble with this installation procedure, do the manual install.

Warning

Only Ubuntu, 64bit tested)

Open the Terminal
Navigate into a folder where you want to store the PiVR software, for example:
```
cd /home/UserA
```

Clone the repository by typing:

git clone https://gitlab.com/louislab/PiVR

Navigate to the “Installation_update” folder of the repository you just cloned:
```
cd /home/UserA/PiVR/PiVR/Installation_update
```
Create the Linux virtual environment for the PiVR software to run using the provided package list by typing:
```
conda create --name PiVR_environment --file PiVR_Linux64.txt
```
Once done, activate the virtual environment by typing:
```
source activate PiVR_environment
```
You know you successfully activated the virtual enviroment if it says ‘(PiVR)’ at the beginnig of the line in the terminal.
Start the software by going into the folder where the file “start_GUI.py” can be found, which is the parent folder of the installation folder you should be in now. So just type:
```
cd ..
```
Start the program by typing:
```
python start_GUI.py
```

9.5. Start PiVR on a PC¶

Note

To run PiVR, you of course need to first install the software.

Open the Anaconda terminal (Windows) or Terminal (MacOS/Linux)
Activate the virtual environment you have created during the installation. If you followed these instructions type:

Windows:
```
activate PiVR_environment
```
Linux/MacOS:
```
source activate PiVR_environment
```
Change directory to the folder where you downloaded the PiVR software into. In the example here we used:
```
cd C:\Users\UserA\Documents\PiVR\PiVR
```
Start PiVR software by typing:
```
python start_GUI.py
```