Installing and updating


  • Make sure your user has permissions to access the serial ports.

  • Execute the next command:

    sudo usermod -a -G dialout [your username]
  • Restart the computer.

User installation

  1. Install Python 3.6.

  2. Install PyBpod from PyPi:

pip install pybpod
  1. Execute PyBpod:



On the first execution a file will be created on the User system folder.

Installation for developers

  1. Download & install Anaconda or Miniconda.


  • On windows if you install Anaconda/Miniconda for all the users, you should make sure you run the “Anaconda Prompt” as administrator.

  • To avoid issues, make sure you install Anaconda/Miniconda only for your user.

2. Download the environment configuration file for your Operating System and create a virtual environment with it by executing the following commands in the “Anaconda Prompt”.

Windows 10: environment-windows-10.yml (right click->Save Link as):

conda env create -f utils/environment-windows-10.yml

Ubuntu 17.10 and up: environment-ubuntu-17.10.yml (right click->Save Link as):

conda env create -f utils/environment-ubuntu-17.10.yml

Mac OSx: environment-macOSx.yml (right click->Save Link as):

conda env create -f utils/environment-macOSx.yml
  1. Activate the environment you just created.

activate pybpod-environment
  1. Clone the PyBpod repository and initialize all the submodules.

git clone
git submodule update --init
  1. Access the created repository folder.

cd pybpod
  1. Run the “” script to install all necessary dependencies.

python utils/
  1. Run the PyBpod application.


Execute PyBpod

  1. Open “Anaconda Prompt” and activate the “pybpod-environment”.

activate pybpod-environment
  1. Run the application, in your pybpod directory.


Update PyBpod

  1. Open the “Anaconda Prompt” and activate the “pybpod-environment”.

activate pybpod-environment
  1. Execute the next commands in your pybpod directory.

git pull
git submodule update --recursive --remote