Skip to content

Commit

Permalink
doc work
Browse files Browse the repository at this point in the history
  • Loading branch information
tkittel committed Jan 31, 2024
1 parent f06cdb5 commit e9329c0
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 11 deletions.
6 changes: 6 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,12 @@ def run_tricorder_cmds():
invoke_in_pkgroot( ['sb_tricorder_sim','-h'],
pkgroot,
bd / 'autogen_tricorder_sim_help.txt' )
invoke_in_pkgroot( ['sb_tricorder_sim','-p'],
pkgroot,
bd / 'autogen_tricorder_sim_p.txt' )
invoke_in_pkgroot( ['sb_tricorder_sim','-g'],
pkgroot,
bd / 'autogen_tricorder_sim_g.txt' )
invoke_in_pkgroot( ['sb_tricorder_sim'],
pkgroot,
bd / 'autogen_tricorder_sim_noargs.txt' )
Expand Down
9 changes: 4 additions & 5 deletions doc/source/extractg4xs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ attempt to interpret the various Geant4 data files and C++ code directly.

.. note::

If your material is defined by an :ref:`NCrystal cfg-string
<sbmatgeneral>`, you can additionally use the ``nctool``
command to investigate the material, to get more detailed information about
the thermal (<5eV) neutron scattering cross sections (for more information
see :ref:`here <sbmatgeneral>` FIXME-betterlink?).
If your material is defined by an :ref:`NCrystal cfg-string <sbmatgeneral>`,
you can additionally use the ``nctool`` command to investigate the material,
to get more detailed information about the thermal (<5eV) neutron scattering
cross sections (for more information see :ref:`here <sbmatgeneral>`).

However, non-neutron, non-scattering, or non-thermal cross sections of the
material in the Geant4 simulations are not provided by ``nctool``, and must
Expand Down
10 changes: 6 additions & 4 deletions doc/source/particlegenerators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ changes the default value of one or more of the parameters available for the
given generator module. Of course, those values can again be overwritten from
the command line should the user of the simulation script so desire). In the
example below, the author of the simulation script in question has decided to
use the SimpleGen generator module from the FIXME G4StdGenerators package:
use the SimpleGen generator module from the :sbpkg:`G4StdGenerators` package:

.. code-block:: python
Expand All @@ -66,7 +66,7 @@ project <sbnewsimproject>`). One can see the available parameters by running the
command with ``-p`` (if you forget that the flag is ``-p`` you can always run with
``-h`` first for usage instructions):

FIXME dynamic:
FIXME dynamic autogen_tricorder_sim_p.txt:

.. code-block::
Expand All @@ -85,8 +85,8 @@ FIXME dynamic:
To understand what the different parameters are for, one can:

- Read on further down this page where all the generators from the
FIXME G4StdGenerators package are mentioned (or on some other wiki page dedicated
to the generator module in question).
:sbpkg:`G4StdGenerators` package are mentioned (or on some other wiki page
dedicated to the generator module in question).
- Guess based on the hopefully very descriptive names of the parameters
- Supply the ``--dataviewer`` or ``--aimdataviewer`` flag to generate and visualise few
or many events in a 3D viewer, and see how the tracks are generated in the
Expand Down Expand Up @@ -115,6 +115,8 @@ Examples of how to select generators and display their parameters (note, in the
example below the ``fixed_y_meters`` parameter was already changed via an
argument):

FIXME dynamic

.. code-block::
$> sb_g4utils_querygenerator -g G4StdGenerators.SimpleGen fixed_y_meters=0.123
Expand Down
2 changes: 1 addition & 1 deletion doc/source/physicslists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ examples of how such commands might look:
launcher.cmd_preinit('/process/eLoss/StepFunctionMuHad 0.1 0.001 um')
launcher.cmd_preinit('/process/eLoss/minKinEnergy 10 eV')
Note the as the name implies, the above commands will be invoked just *before*
Note that as the name implies, the above commands will be invoked just *before*
the Geant4 run-manager object is initialised. If for some reason, you need to
ensure that they are instead invoked *after* the run-manager is initialised, you
must instead use ``launcher..cmd_postinit("...")``
Expand Down
2 changes: 1 addition & 1 deletion doc/source/simplehists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ retaining correct statistical metadata.
Imagine for instance the following to be part of some big event loop running on
the cluster (FIXME dynamic injection of the following example):

.. code-block:: C++
.. code-block:: c++

SimpleHists::HistCollection hc;
auto h_edep = hc.book1D("Energy deposited in counting gas",100,0.0,2000,"edep");
Expand Down

0 comments on commit e9329c0

Please sign in to comment.