Skip to content

Latest commit

 

History

History
144 lines (100 loc) · 4.1 KB

USER_README.md

File metadata and controls

144 lines (100 loc) · 4.1 KB
Raw

TPCReco in a container

TPCReco as available for Linux and macOS through the container technology:

Getting started

Singularity on Linux

Preparation:

  • install singularity,

  • create and enter directory for reconstruction,

  • copy data files and 'elitpc_tpcreco_latest.si' to that directory,

  • initialize that directory by executing:

    singularity exec --bind "$PWD" elitpc_tpcreco_latest.sif cp -r /opt/soft/TPCReco/resources/. .

Running:

  • go to directory created during preparation step,

  • start a container:

    singularity shell --bind "$PWD" elitpc_tpcreco_latest.sif

  • run tpcGUI.

Docker on Linux

Preparation:

  • install docker,

  • download 'elitpc_tpcreco_latest.tar' file,

  • load image:

    sudo docker load -i elitpc_tpcreco_latest.tar

  • create and enter directory for reconstruction,

  • copy data files to this directory,

  • initialize that directory by executing:

    sudo docker run --rm  --user $(id -u) -v "$PWD:/scratch" --workdir /scratch elitpc/tpcreco:latest cp -r /opt/soft/TPCReco/resources/. .

Running:

  • go to directory created during preparation step,

  • start a container:

    sudo docker run -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix --rm -it --user $(id -u) -v "$PWD:/scratch" --workdir /scratch elitpc/tpcreco:latest

    NOTE: on some distributions (e.g. Arch Linux) executing xhost local:root is necessary. In that case consider executing also xhost - at the end of the session.

  • run tpcGUI.

Docker on macOS:

Preparation:

  • install:

  • start docker application,

  • download 'elitpc_tpcreco_latest.tar' file,

  • load docker image:

    sudo docker load -i elitpc_tpcreco_latest.tar

  • Open XQuartz, and go to XQuartz, Preferences, select the Security tab, and tick the box "Allow connections from network clients". Then exit XQuartz,

  • create and enter directory for reconstruction,

  • copy data files to this directory,

  • initialize that directory by executing:

    sudo docker run --rm  --user $(id -u) -v "$PWD:/scratch" --workdir /scratch elitpc/tpcreco:latest cp -r /opt/soft/TPCReco/resources/. .

Running:

  • start docker application,

  • go to directory created during preparation step,

  • allow network X11 connection from localhost by executing:

    xhost +localhost

  • start a container:

    sudo docker run -e DISPLAY=host.docker.internal:0 -v /tmp/.X11-unix:/tmp/.X11-unix --rm -it --user $(id -u) -v "$PWD:/scratch" --workdir /scratch elitpc/tpcreco:latest

  • run tpcGUI.

Vagrant + Singularity on macOS

Preparation:

  • install:
  • create directory for reconstruction. Copy to this directory 'elitpc_tpcreco_latest.sif', 'Vagrantfile' and data files (.graw).

Running:

  • start XQuartz,

  • go to directory created during preparation step and run:

    vagrant up && vagrant ssh

    NOTE: At the end of session run vagrant halt otherwise the container will continue in a background.

  • run tpcGUI.

Running tpcGUI

Go to directory created during preparation step and start a container according to instructions for your system.

Start tpcGUI:

tpcGUI /opt/soft/TPCReco/config/config_GUI__OFFLINE_250mbar_12.5MHz.json --dataFile CoBo_ALL_AsAd_ALL_2021-06-22T12\:01\:56.568_0000.graw

Change --dataFile to your data file and change config according to experimental conditions for this run.

The output files should appear in both container and host system.