olantwin/fairship repository overview

⁠FairShip

⁠Introduction

FairShip is the software framework for the SHiP experiment which is based on FairRoot. The dependencies of FairShip are tracked and installed using alibuild⁠.

⁠Branches

master

Main development branch. All python code is required to be compatible with python 2 and 3 until compatibility with python 2 can be dropped. Requires aliBuild default fairship.

SHiP-2018

Frozen branch for the CDS, kept for backward compatibility. Python 2 only. Requires aliBuild default fairship-2018.

muflux

Branch for the muon flux analysis. Python 2 only. Requires aliBuild default fairship-2018.

All packages are managed in Git and GitHub. Please read the Git tutorial for SHiP⁠ first, even if you already know Git, as it explains how development is done on GitHub.

⁠Build Instructions using CVMFS

1. Download the FairShip software

   git clone https://github.com/ShipSoft/FairShip.git
   

   Copy

2. Make sure you can access the SHiP CVMFS Repository

   ls /cvmfs/ship.cern.ch
   

   Copy

3. Source the setUp script

   source /cvmfs/ship.cern.ch/SHiP-2020/latest/setUp.sh
   

   Copy

4. Build the software using aliBuild

   aliBuild build FairShip --default fairship --always-prefer-system --config-dir $SHIPDIST
   

   Copy

   If you are not building master, you will need to select the appropriate default (see Branches⁠).

If you exit your shell session and you want to go back working on it, make sure to re-execute the third step.

To load the FairShip environment, after you build the software you can simply use:

1. Load the environment

   alienv enter FairShip/latest
   

   Copy

However, this won't work if you are using HTCondor. In such case you can do:

eval alienv load FairShip/latest

⁠Local build, without access to CVMFS

Commands are similar to the previous case, but without access to CVMFS you need to build the required packages.

1. Download the FairShip software

   git clone https://github.com/ShipSoft/FairShip.git
   

   Copy
2. Build the software using aliBuild

   FairShip/aliBuild.sh
   

   Copy
3. Load the environment

   alibuild/alienv enter FairShip/latest
   

   Copy

⁠Run Instructions

Set up the bulk of the environment from CVMFS.

source /cvmfs/ship.cern.ch/SHiP-2018/latest/setUp.sh

Load your local FairShip environment.

alibuild/alienv enter (--shellrc) FairShip/latest

Now you can for example simulate some events, run reconstruction and analysis:

python $FAIRSHIP/macro/run_simScript.py
>> Macro finished succesfully.
>> Output file is  ship.conical.Pythia8-TGeant4.root

python $FAIRSHIP/macro/ShipReco.py -f ship.conical.Pythia8-TGeant4.root -g geofile_full.conical.Pythia8-TGeant4.root
>> finishing pyExit

python -i $FAIRSHIP/macro/ShipAna.py -f ship.conical.Pythia8-TGeant4_rec.root -g geofile_full.conical.Pythia8-TGeant4.root
>> finished making plots

Run the event display:

python -i $FAIRSHIP/macro/eventDisplay.py -f ship.conical.Pythia8-TGeant4_rec.root -g geofile_full.conical.Pythia8-TGeant4.root
// use SHiP Event Display GUI
Use quit() or Ctrl-D (i.e. EOF) to exit

⁠Docker Instructions

Docker is not the recommended way to run FairShip locally. It is ideal for reproducing reproducible, stateless environments for debugging, HTCondor and cluster use, or when a strict separation between FairShip and the host is desirable.

1. Build an docker image from the provided Dockerfile:

   git clone https://github.com/ShipSoft/FairShip.git
   cd FairShip
   docker build -t fairship .
   

   Copy
2. Run the FairShip docker image:

   docker run -i -t --rm fairship /bin/bash
   

   Copy
3. Advanced docker run options:

   docker run -i -t --rm \
   -e DISPLAY=unix$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \
   -v /local_workdir:/image_workdir \
   fairship /bin/bash
   

   Copy
   The option -e DISPLAY=unix$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix forwards graphics from the docker to your local system (similar to ssh -X). The option -v /local_workdir:/image_workdir mounts /local_workdir on the local system as /image_workdir within docker.

⁠Contributing Code

⁠Build Targets Related to C++ Code Style-Guide

The following targets are only available if clang-format, clang-tidy and git are installed.

Build targets indicated with * always come in three different flavors.

• no-suffix: executes the target on source files that changed compared to origin/master -- e.g. make check-format
• -staged: executes the target on source files that have been staged -- e.g. make check-format-staged
• -all: executes the target on all source files in the project -- e.g. make check-format-all