diff --git a/docs/_images/detector_transparent_bk.png b/docs/_images/detector_transparent_bk.png new file mode 100644 index 0000000000000000000000000000000000000000..ebd25803bf39b58533a9ee530bd59bd315fe515e Binary files /dev/null and b/docs/_images/detector_transparent_bk.png differ diff --git a/docs/_images/mceg_hepmc_full_stack.png b/docs/_images/mceg_hepmc_full_stack.png new file mode 100644 index 0000000000000000000000000000000000000000..08409efa6abdba5c7d4574cc37d633147a2e95a5 Binary files /dev/null and b/docs/_images/mceg_hepmc_full_stack.png differ diff --git a/docs/_images/mceg_hepmc_stack.png b/docs/_images/mceg_hepmc_stack.png new file mode 100644 index 0000000000000000000000000000000000000000..ec4e944c71bad269bd420e78ff13cd9164c9b793 Binary files /dev/null and b/docs/_images/mceg_hepmc_stack.png differ diff --git a/docs/howto/mceg.rst b/docs/howto/mceg.rst new file mode 100644 index 0000000000000000000000000000000000000000..fa7b91aa5870156b3abb22038deb6cc33dd03afb --- /dev/null +++ b/docs/howto/mceg.rst @@ -0,0 +1,65 @@ +Process MCEG +============ + +- How to run MCEG files throught the Software +- What are the requirements and limitations for the MCEG +- How to convert files to the right format +- How to apply beam effects and crossing angle + +MCEG Overview +------------- + +.. figure:: ../_images/mceg_hepmc_stack.png + :alt: Hepmc in software stack + :width: 800 + +Athena full simulation and reconstruction stack accepts only HepMC2 and HepMC3 as an input format. +The reason for that is that support for many formats on simulation/reconstruction level +leads to increasing number of bugs witch are difficult to mitigate with testing because of the combinatorics. +It is much easier in terms of testing, robustness and reprodusobility to have a reliable chain that works with one +(universal) format and have well tested standalone satelite conventers, that allow to work with different +MCEG software (see the next picture). + + +.. figure:: ../_images/mceg_hepmc_full_stack.png + :alt: Hepmc conversion in the software stack + :width: 800 + +- **Converters** allow to convert other formats to HepMC +- **Afterburner** applies crossing angle and beam effects + +Convert MCEG +------------ + +Currently there are 2 packages that allow to convert different MCEG to HepMC + +- `EicSmear <https://github.com/eic/eic-smear>`__ - and old (means well tested) and reliable package + that allows to convert various (and especially old) MCEG to HepMC format. + `Instruction how to convert to HepMC <https://github.com/eic/eic-smear#creation-of-hepmc-output>`__ + It is recommended to use EicSmear especially for BNL RootTree files. +- `mcconv <https://eicweb.phy.anl.gov/monte_carlo/mcconv>`__ - new and less reliable, but kind of easier + to use for users and also has convenient python API. mcconv correctly works with GEMC LUND (Clas12) format. + + +Crossing angle and beam effects +------------------------------- + +In order to apply crossing and beam effects to existing HepMC files `EIC Afterbur <https://eicweb.phy.anl.gov/monte_carlo/afterburner>`__ +is to be used. The package provides framework independent well validated crossing angle and beam effects C++ library and HepMC file converter (abconv) +for Electron Ion Collider. + + +**Physics simulated:** + +- Crossing angle +- Beam effects (divergence, crabbing kick, etc.) +- Vertex spread (position, time) + +Please follow the `instruction of how to use the afterburner <https://eicweb.phy.anl.gov/monte_carlo/afterburner>`__. + + +Using converters and afterburner +-------------------------------- + +Both converters and aferburner are parts of the container. And could be used from JLab and BNL farm. +Follow singularity chapter. diff --git a/docs/index.rst b/docs/index.rst index 0a59315b30269df8de2af5a08bf460571cf2ec62..0b7e991ece5e0ab268545791292c78d71550828f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,6 +29,7 @@ ATHENA Software :maxdepth: 1 :caption: HOWTOs: + howto/mceg howto/run_fast_simulation howto/full_simulation howto/use_singularity