Installing¶

Note

To install the full pybpod package, please follow the instructions located @ Pybpod.

Installing for using the library¶

The library is available through PyPI so you just have to do

pip install pybpod-api

Installing for making changes to the library¶

Clone the repository

git clone https://github.com/pybpod/pybpod-api

On the project root folder (where ‘setup.py’ is located) run the following command
pip install -e . # installs this API in development mode
Use your code editor of choice to make your changes.

Settings file¶

# list of python libraries to interface with bpod modules.
PYBPOD_API_MODULES = [
    'pybpod_rotaryencoder_module'
]

PYBPOD_SERIAL_PORT = '/dev/ttyACM0'  # serial port settings
PYBPOD_NET_PORT    = '' # network port to receive remote commands like softcodes.

# enable or disable bpod ports
BPOD_BNC_PORTS_ENABLED      = [True, True]
BPOD_WIRED_PORTS_ENABLED    = [True, True]
BPOD_BEHAVIOR_PORTS_ENABLED = [True, True, True, True, True, True, True, True]

PYBPOD_PROTOCOL     = '' # Executed protocol
PYBPOD_CREATOR      = '' # Name of the user
PYBPOD_PROJECT      = '' # Name of the project
PYBPOD_EXPERIMENT   = '' # Name of the experiment
PYBPOD_BOARD        = '' # Board name
PYBPOD_SETUP        = '' # Setup name
PYBPOD_SESSION      = '' # Name of the session file
PYBPOD_SESSION_PATH = '' # Folder where the bpod output files are be saved
PYBPOD_SUBJECTS     = [] # List of subjects to be saved in the session file.