iblpybpod

version: 2.0.0

iblpybpod is a GUI application that enables interaction with the Bpod device from Sanworks. Much credit and thanks go to the original creators of the pybpod project.

This project has recently been adopted by the software development team at the International Brain Lab to bring the code into modernity.

Installation for use

Currently, only Python v3.8 on Ubuntu 22.04 and Windows 10 is being tested.

Python venv commands for setup

python3.8 -m venv iblpybpod
source iblpybpod/bin/activate
python -m pip install --upgrade pip wheel
python -m pip install iblpybpod
start-pybpod

Anaconda commands for setup

conda create --name iblpybpod python=3.8
conda activate iblpybpod
pip install iblpybpod
start-pybpod

For developers

This repository is adhering to the following conventions:

• semantic versioning for consistent version numbering logic
• gitflow for managing branches
• Flake8 for style guide enforcement

Please review these conventions to more easily contribute to the project.

New feature branches:

• a new_feature branch is forked from the current develop branch
• the new_feature branch is then merged back into the develop branch
• the new_feature branch will eventually be deleted

Release candidate branches:

• a release candidate, rc branch is a "pre-release" branch for beta testers on production rigs
• the rc branch is forked from the develop branch
• once the rc has been thoroughly tested, it will be merged into master and develop
• the rc branch will eventually be deleted

Hotfix branches:

• a hotfix or maintenance branch is forked from master
• once the fix has been thoroughly tested, it will get merged back into master and develop
• the hotfix branch will eventually be deleted

Python venv commands for setup

python3.8 -m venv iblpybpod-dev
source iblpybpod-dev/bin/activate
python -m pip install --upgrade pip wheel
git clone https://github.com/int-brain-lab/iblpybpod
python -m pip install --editable iblpybpod

Anaconda commands for setup

conda create --name iblpybpod-dev python=3.8
conda activate iblpybpod-dev
git clone https://github.com/int-brain-lab/iblpybpod
pip install --editable iblpybpod