Installing VIBE to your local machine

Prerequisites

It is recommended that you create a virtual environment for your local version of VIBE. There are many ways to do this, the easiest is using venv like so:

$ python3 -m venv .venv

Now you will have a directory .venv, your virtual environment! It can be activated using the command:

$ source .venv/bin/activate

You may now see (.venv) at the beginning of your terminal, this means its activated! To check you have successfully activated your virtual environment run:

$(.venv) which python3
path/to/your/.venv/bin/python3

Installation

To install VIBE into your virtual environment, first we need to clone the VIBE-Validation Interface for the Belle II Experiment repo:

$(.venv) git clone git@gitlab.desy.de:belle2/data-production/validation/vibe.git

Now cd into vibe and run this command:

$(.venv) pip3 install --user -e ./

The -e installs an egg which allows us to make changes to VIBE (i.e add your mode) without having to install a new version each time a change is made. The ./ tells pip3 that we want to use the setup.py in the current working directory, which is VIBE’s!

From here you will likely want to create a new branch of VIBE to add your new modes, which can be done like so:

$(.venv) git checkout -b <my_branch_name>

You will now be working on a new git branch made from the main branch!