Skip to content

Commit

Permalink
doc work
Browse files Browse the repository at this point in the history
  • Loading branch information
tkittel committed Jan 29, 2024
1 parent 400acfc commit 0ebcd87
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
# simplebuild-dgcode
dgcode: the Geant4-based simulation framework of the ESS Detector Group. Provided as simple-build-system bundles.

The Geant4-based simulation framework of the ESS Detector Group ("dgcode").
Provided as simple-build-system bundles.

Please refer to the website for details about usage and installation:
https://mctools.github.io/simplebuild-dgcode/
4 changes: 2 additions & 2 deletions doc/source/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Geant4-based simulation framework implemented as a set of simplebuild packages
The main active developers are currently:

* Thomas Kittelmann (DMSC, European Spallation Source ERIC). Main developer.
* Milan Klausz (Centre for Energy Research, MTA EK). Developer and CI expert.

* Milan Klausz (HUN-REN Centre for Energy Research). Developer and CI expert.
Historically several other people also contributed to the development of the
code. Of particular note is the work and support by Kalliopi Kanaki (former ESS
ERIC, now IAEA), Xiao Xiao Cai (former DTU, now CSNS) and Richard Hall-Wilton
Expand Down
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome to the documentation of "dgcode", a set of `simplebuild
<https://mctools.github.io/simplebuild>`_ packages implementing a Geant4-based
simulation framework. It originated in the Detector Group at the European
Spallation Source ERIC, and is primarily intended for usage for simulation of
neutron detectors and related projects.
thermal neutron detectors and related projects.

Note, that you can browse this documentation in order via the button marked
**"Next"** (or use your keyboards Left and Right arrow keys as a short
Expand Down
2 changes: 2 additions & 0 deletions doc/source/particlegenerators.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Particle generators for Geant
******************************

.. include:: wipwarning.rst

As important for a Geant4 simulation as geometry, materials and physics list, is
the initial set of particles to be "let loose" in the simulation each event:
these source particles are called *primary* particles in Geant4 terminology, and
Expand Down

0 comments on commit 0ebcd87

Please sign in to comment.