PG-RAD is a command-line software package for simulating localisation of orphan sources using mobile gamma spectrometry. PG-RAD provides a framework for construction road geometries, arbitrary distributions of point sources, modelling the detector response to primary gammas. PG-RAD provides a configurable framework for constructing detector trajectories, defining radioactive source distributions, modelling detector response, and generating synthetic acquisition data. User input is specified through YAML configuration files, which makes simulations reproducible and easily shared.
PG-RAD is a Python 3 package and is only tested on x86_64 Linux systems. The following installation instructions were testing for a fresh virtual machine running Ubuntu 26.04 LTS.
- Install git by
sudo apt update && sudo apt install git - Install miniforge by following these instructions.
- Create a file called
environment.yml, and paste the following in there:
name: my-pgrad-env
channels:
- conda-forge
dependencies:
- python=3.12
- pip:
- git+ssh://git@github.com/pim-n/pg-rad.git@v0.1.0- Run
conda env create -f environment.ymlto create the environment - Run
conda activate pg-rad-analysis. You should now be in the conda environmentmy-pgrad-env. - To test if installation was succesful, run
pgrad --example --show. If this runs without errors and produces visual output, PG-RAD is correctly installed.
If you prefer another virtual environment, you still need git installed. Ensure the Python version of the environment is >3.12.4 and <3.13. Then, with your virtual environment activated, run pip install git+ssh://git@github.com/pim-n/pg-rad.git@main. Run pgrad --example --show to check if the installation was successful.