Installation

Using virtualenv

Obtaining the package

Change to a directory where you want to place the TPCwithDNN package. In there, type

git clone https://github.com/AliceO2Group/TPCwithDNN.git

and you will find a new directory TPCwithDNN.

RootInteractive

RootInteractive depends on AliRoot, so you need to build AliRoot (it is already built on aliceml) and enter its environment:

alienv enter AliRoot/latest

If you don't use the RootInteractive parts (notebooks with validation plots), you can process without AliRoot. You might see some warnings after launching the software but this doesn't affect the program logic.

Prepare the virtual environment

To keep the python environment clean, we will use a virtual environment for the software setup. Dealing with that is handled by TPCwithDNN/load.sh and there are 3 scenarios when you type

source load.sh # This you can actually source from anywhere

1. If the environment has not been created yet, sourcing will create and enter it.
2. Being inside the environment, sourcing it again will leave the environment.
3. Outside of the environment, source load.sh --recreate will delete and re-install it.

From inside the virtual environment, change to TPCwithDNN/ where you can find setup.py. To install the package with all its dependencies, run

pip install -e .

Using singularity containers

In progress

Google Cloud

You can find the instructions for the Google Cloud machines here.