From 76aaa907a472e6230e03eb0382a44d8a97f2c42b Mon Sep 17 00:00:00 2001 From: Zoya Date: Tue, 13 Aug 2019 14:21:37 -0700 Subject: [PATCH] Update README.md Instructions to access the docker image that sets up the g4py environment correctly. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dca1c64..856465a 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,19 @@ Very primitive Python-based Geant4 simulation of particle interactions in liquid * ROOT * Geant4 * g4py (which requires boost and XercesC) + + A docker image which sets up the correct environment with the above mentioned packages is available at docker hub: zoyavallari/g4pybuild . + This image on the docker hub can be used to build a container with any container platform such as docker, singularity or shifter. + > $ docker pull zoyavallari/g4pybuild -## Example Usage: +or + +> $ singularity build container_name.sif docker://zoyavallari/g4pybuild +A volume that contains argon_box code should be bound to the container. +The dockerfile itself is available at: https://github.com/zoyavallari/ContainerFiles/blob/master/g4pyenv.dockerfile + +## Example Usage: Mono-energetic particles: > $ python argon_box.py --nevents=100 --source='e-' --energy=2.0 --output='electron_2GeV_sim.root'