Welcome to pygeomhades’s documentation!

Python package containing the Monte Carlo geometry implementation of the LEGEND HPGe characterization test stand in HADES.

This geometry can be used as an input to the remage simulation software.

This package is based on pyg4ometry, legend-pygeom-hpges (implementation of HPGe detectors) and legend-pygeom-tools.

Installation

The latest tagged version and all its dependencies can be installed from PyPI:

pip install legend-pygeom-hades

Alternatively, the packages’s development version can be installed from a git checkout (in the directory of the git checkout):

pip install -e .

Usage as CLI tool

After installation, the CLI utility legend-pygeom-hades is provided on your $PATH. This CLI utility is the primary way to interact with this package. For now, you can find usage docs by running:

$ legend-pygeom-hades -h

In the simplest case, you can create a usable geometry file with:

$ legend-pygeom-hades hades.gdml --config <FILE>

More details on the configuration file are given in Configuration.

Extra metadata

Some additional metadata is needed to describe the vacuum cryostat test stand geometry. This is described in Additional metadata.

Next steps

User Manual

  • legend-pygeom-hpges: high-purity germanium detector geometries for radiation transport simulations.

  • legend-pygeom-tools: general-purpose tools for implementing and visualizing geometries.

  • legend-pygeom-l200 and legend-pygeom-l1000: the LEGEND-200 and LEGEND-1000 geometries for radiation transport simulations, useful examples of complex experimental setup implementations.

  • reboost: post-processing and analysis of remage output.