From 2ed48cd490982b514e382034d6db011039ecb958 Mon Sep 17 00:00:00 2001 From: Luigi Pertoldi Date: Thu, 19 Dec 2024 18:48:36 +0100 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++++++++++++++----------------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 14505784..e517e238 100644 --- a/README.md +++ b/README.md @@ -9,32 +9,44 @@ Simulation framework for germanium detector experiments [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) ![GitHub issues](https://img.shields.io/github/issues/legend-exp/remage?logo=github) ![GitHub pull requests](https://img.shields.io/github/issues-pr/legend-exp/remage?logo=github) -![License](https://img.shields.io/github/license/legend-exp/remage) [![Read the Docs](https://img.shields.io/readthedocs/remage?logo=readthedocs)](https://remage.readthedocs.io) +[![Docker Hub](https://img.shields.io/badge/Docker-Hub-blue?logo=docker)](https://hub.docker.com/r/legendexp/remage) +![License](https://img.shields.io/github/license/legend-exp/remage) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11115662.svg)](https://doi.org/10.5281/zenodo.11115662)
-The *remage* project aims to provide a modern Geant4-based C++ library to -efficiently simulate particle physics processes in typical germanium detector -experiments. The library is setup-agnostic, and therefore the only mandatory -user action is to provide a geometrical implementation of the experimental -setup (supported specification languages are C++, GDML and more). The user can -then benefit from a predefined set of tools to perform common actions (physics -generators, standard output classes, etc). +The *remage* project aims to deliver a modern Geant4-based C++ library designed +for efficient simulation of particle physics processes in typical germanium +detector experiments. The library is setup-agnostic, requiring users only to +define the experimental setup's geometry. Supported specification languages +include C++, GDML, and others. Once the geometry is provided, users can access +a comprehensive suite of tools for common tasks, such as physics generation and +standard output handling. + +Get started with our [documentation pages](https://remage.readthedocs.io)! ### Main features -* Support for modern [Geant4](https://geant4.web.cern.ch), including - * Multithreading - * [VecGeom](https://gitlab.cern.ch/VecGeom/VecGeom) support for vectorized - solids - * [GDML](https://gdml.web.cern.ch/GDML) support - * Multiple output file formats ([ROOT](https://root.cern.ch), - [HDF5](https://www.hdfgroup.org/solutions/hdf5)...) +* Low entry barrier: Most simulations can be executed directly using the + `remage` executable and a macro file, eliminating the need to write or + compile C++ code. +* Various pre-compiled *remage* versions available on + [Docker Hub](https://hub.docker.com/repository/docker/legendexp/remage) +* Support for modern [Geant4](https://geant4.web.cern.ch), including: + * Multithreading + * [GDML](https://gdml.web.cern.ch/GDML) support + * Multiple output file formats ([ROOT](https://root.cern.ch), + [HDF5](https://www.hdfgroup.org/solutions/hdf5)...) +* [LEGEND HDF5 (LH5)](https://legend-exp.github.io/legend-data-format-specs/dev/hdf5/) + output format * Fast third-party cosmic muon generator (through [EcoMug](https://doi.org/10.1016/j.nima.2021.165732)) +* Support for external generators: + * [MUSUN](https://doi.org/10.1016/j.cpc.2008.10.013) + * [MAURINA](https://doi.org/10.1140/epja/s10050-024-01336-0) * Third-party double-beta decay generator (through [bxdecay0](https://github.com/BxCppDev/bxdecay0)) -* Advanced vertex confinement on physical volumes, geometrical solids, surfaces and intersections -* Common output schemes for HPGe and optical detectors +* Advanced vertex confinement on physical volumes, geometrical solids, surfaces + and intersections +* Sensible output schemes for HPGe and optical detectors