Skip to content
Snippets Groups Projects
Commit 439d2ad2 authored by Andrii Verbytskyi's avatar Andrii Verbytskyi Committed by Adam Edward Barton
Browse files

Move the documentation from packagedoc headers to README.md for Generators 

Move the documentation from  packagedoc headers to README.md for Generators
parent 8d2f7dfe
No related branches found
No related tags found
28 merge requests!78241Draft: FPGATrackSim: GenScan code refactor,!78236Draft: Switching Streams https://its.cern.ch/jira/browse/ATR-27417,!78056AFP monitoring: new synchronization and cleaning,!78041AFP monitoring: new synchronization and cleaning,!77990Updating TRT chip masks for L1TRT trigger simulation - ATR-28372,!77733Draft: add new HLT NN JVT, augmented with additional tracking information,!77731Draft: Updates to ZDC reconstruction,!77728Draft: updates to ZDC reconstruction,!77522Draft: sTGC Pad Trigger Emulator,!76725ZdcNtuple: Fix cppcheck warning.,!76611L1CaloFEXByteStream: Fix out-of-bounds array accesses.,!76475Punchthrough AF3 implementation in FastG4,!76474Punchthrough AF3 implementation in FastG4,!75729New implementation of ZDC nonlinear FADC correction.,!75703Draft: Update to HI han config for HLT jets,!75184Draft: Update file heavyions_run.config,!74430Draft: Fixing upper bound for Delayed Jet Triggers,!73963Changing the path of the histograms to "Expert" area,!73875updating ID ART reference plots,!73874AtlasCLHEP_RandomGenerators: Fix cppcheck warnings.,!73449Add muon detectors to DarkJetPEBTLA partial event building,!73343Draft: [TrigEgamma] Add photon ringer chains on bootstrap mechanism,!72336Fixed TRT calibration crash,!72176Draft: Improving L1TopoOnline chain that now gets no-empty plots. Activating it by default,!72012Draft: Separate JiveXMLConfig.py into Config files,!71876Fix MET trigger name in MissingETMonitoring,!71820Draft: Adding new TLA End-Of-Fill (EOF) chains and removing obsolete DIPZ chains,!71682Move the documentation from packagedoc headers to README.md for Generators
Hide whitespace changes
Inline Side-by-side
Generators/CosmicGenerator/doc/packagedoc.h → Generators/CosmicGenerator/README.md
+ 33
− 0
View file @ 439d2ad2
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
# CosmicGenerator
/**
@page CosmicGenerator_page CosmicGenerator
@author W. Seligman, M. Shapiro, I. Hinchliffe, M. Zdrazil,
Authors: W. Seligman, M. Shapiro, I. Hinchliffe, M. Zdrazil,
@section CosmicGenerator_General information
## General information
CosmicGenerator package is a generator used for the cosmic particle production.
The output will is stored in the transient event store so it can be passed to t
......@@ -20,28 +16,18 @@ ns depending on their direction and energy.
If you look in jobOptions_ConfigCosmicProd.py, you will find that the following
properties can be set:
* CosmicGenerator.emin, CosmicGenerator.emax: energy range for the primary m
uon
* CosmicGenerator.xvert_low, CosmicGenerator.xvert_high, CosmicGenerator.zv
ert_low, CosmicGenerator.zvert_high: the (x,z) surface at ground level in which
the primary vertex has to be created
* CosmicGenerator.yvert_val: the y quota at which the primary vertexes must
be created (i.e. the "ground level")
* CosmicGenerator.ctcut: angular cut (wrt to the vertical)
- CosmicGenerator.emin, CosmicGenerator.emax: energy range for the primary muon
Another set of properties allows further optimization:
- CosmicGenerator.xvert_low, CosmicGenerator.xvert_high, CosmicGenerator.zvert_low, CosmicGenerator.zvert_high: the (x,z) surface at ground level in which the primary vertex has to be created
- CosmicGenerator.yvert_val: the y quota at which the primary vertexes must be created (i.e. the "ground level")
* CosmicGenerator.OptimizeForCavern: if True, muons are passed to the simul
ation only if they are pointing towards the interaction point, within a given t
olerance. In order for this to work, the CosmicGenerator must be informed on wh
ere the IP is exactly. This is what the next properties are for
* CosmicGenerator.IPx, CosmicGenerator.IPy, CosmicGenerator.IPz: the (x,y,z
) coordinates of the IP
* CosmicGenerator.Radius: the tolerance of the direction filtering. Only mu
ons pointing inside a sphere centered in the IP with the given radius will be a
ccepted.
- CosmicGenerator.ctcut: angular cut (wrt to the vertical)
Another set of properties allows further optimization:
- CosmicGenerator.OptimizeForCavern: if True, muons are passed to the simulation only if they are pointing towards the interaction point, within a given tolerance. In order for this to work, the CosmicGenerator must be informed on where the IP is exactly. This is what the next properties are for
- CosmicGenerator.IPx, CosmicGenerator.IPy, CosmicGenerator.IPz: the (x,y,z) coordinates of the IP
*/
- CosmicGenerator.Radius: the tolerance of the direction filtering. Only muons pointing inside a sphere centered in the IP with the given radius will be accepted.
Generators/GeneratorFilters/doc/packagedoc.h deleted 100644 → 0
+ 0
− 35
View file @ 8d2f7dfe
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
/**
<i>
This package contains a set of algorithms that run from within Athena.
The algorithms extract the generated Monte Carlo event from the
transient event store (Storegate) and then test for various criteria.
The base class GenFilter extracts the event from Storegate
and makes it available; all the other filter classes inherit from this.
The events are in HepMC format which is independent of the actual
Monte Carlo generator. The same filter can therefore be used with
Isajet, Herwig, Pythia etc. Users are directed to the
ElectronFilter which illustrates the basic logic and can be used
as a template for preparing other classes. (Note that SampleFilter
is easier to read as it does not use the base class, but users
should not use SampleFilter as a template as their code will not then
be protected against changes in the way the events are held in
Storegate).
@author Ian Hinchliffe, Judith Katzy
</i>
@page GeneratorFilters_page
*/
Generators/GeneratorObjectsAthenaPool/doc/packagedoc.h → Generators/GeneratorObjectsAthenaPool/README.md
+ 4
− 13
View file @ 439d2ad2
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
/**
@page GeneratorObjectsAthenaPool_page GeneratorObjectsAthenaPool Package
# GeneratorObjectsAthenaPool Package
The package which defines POOL converters for general Monte-Carlo classes.
@authors Sebastien Binet, Georgios Stavropoulos, Davide Costanzo
Authors: Sebastien Binet, Georgios Stavropoulos, Davide Costanzo
@section GeneratorObjectsAthenaPool_GeneratorObjectsAthenaPoolIntro Introduction
## Introduction
The MonteCarlo classes (e.g. @c HepMC::GenEvent ) are stored on disk through the so-called POOL persistification technology which insulates client code (Athena) from technology details and provides transparent switch of different storage backends (ROOT, MySQL,...)
This package provides the needed boilerplate code to use the T/P converters provided by the GeneratorObjectsTPCnv package (see twiki page about Transient/Persistent separation: https://twiki.cern.ch/twiki/bin/view/Atlas/TransientPersistentSeparation) and make them available to the GAUDI framework.
@section GeneratorObjectsAthenaPool_GeneratorObjectsAthenaPoolSeeAlso See also
## See also
You may also be interested in having a look at the GeneratorObjectsTPCnv package which defines and provides various T/P converters for the MonteCarlo classes.
*/
Generators/GeneratorObjectsTPCnv/doc/packagedoc.h → Generators/GeneratorObjectsTPCnv/README.md
+ 4
− 14
View file @ 439d2ad2
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
/**
@page GeneratorObjectsTPCnv_page GeneratorObjectsTPCnv Package
# GeneratorObjectsTPCnv Package
This package defines the so-called T/P converters for Monte-Carlo classes.
@authors Sebastien Binet, Georgios Stavropoulos, Davide Costanzo
Authors Sebastien Binet, Georgios Stavropoulos, Davide Costanzo
@section GeneratorObjectsTPCnv_GeneratorObjectsTPCnvIntro Introduction
## Introduction
The ATLAS software, in order to provide backward compatibility (and extensive schema evolution) of on-disk stored data, decouples the transient classes that one manipulates in-memory and the persistent classes that one writes on disk.
To achieve this, a robust (and quite performant) Transient/Persistent separation library has been written.
This library has the responsibility for converting all (or a subset of) previous versions of persistent classes into the latest and finest in-memory representation of a given class.
The GeneratorObjectsTPCnv package provides that functionality for the MonteCarlo objects (e.g. @c HepMC::GenEvent).
The GeneratorObjectsTPCnv package provides that functionality for the MonteCarlo objects (e.g. `HepMC::GenEvent`).
As other transient (and hence persistent) classes may also need to re-use that functionality, the core of the conversion is provided as an installed library (so symbols are exported) so other component and/or installed libraries can link against (to prevent code duplication).
See https://twiki.cern.ch/twiki/bin/view/Atlas/TransientPersistentSeparation for a broader and more detailed of how the T/P separation of classes is working and implemented.
*/
Generators/Herwig7_i/doc/packagedoc.h → Generators/Herwig7_i/README.md
+ 5
− 17
View file @ 439d2ad2
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
# Herwig7_i
/**
@page Herwig7_i_page Herwig7_i
@section Herwig7_i_Herwig7ForATLAS Herwig 7 for ATLAS
## Herwig 7 for ATLAS
Herwig 7 is a general-purpose event generator written in C++.
It provides a significant amount of improvements and new features with respect
......@@ -21,7 +16,7 @@ For more information on Herwig 7 in ATLAS please refer to the TWiki pages at
https://twiki.cern.ch/twiki/bin/view/AtlasProtected/Herwig7ForAtlas
@subsection AthenaInterface The Interface between Herwig7 and Athena
## The Interface between Herwig7 and Athena
Herwig 7 can be used in the same way as the Herwig++ 2.X series, in particular
it is capable of showering MadGraph5_aMC\@NLO and PowhegBox events.
......@@ -33,15 +28,8 @@ matching strategies, called 'subtractive' (MCatNLO-like) and 'multiplicative'
shower and the dipole shower. Integration of these new features in the interface
is still ongoing and will need to be validated afterwards.
\note Currently, showering of Alpgen inputs is deprecated and was removed from
### Note
Currently, showering of Alpgen inputs is deprecated and was removed from
the interface since it would require a significant amount of validation. In case
your are interested in this, please let us know.
@subsection TableOfContents Contents of this Documentation
- @ref Links
- @ref FAQ
- @ref MC15JobOptions
*/
Generators/Hijing_i/doc/packagedoc.h → Generators/Hijing_i/README.md
+ 2
− 12
View file @ 439d2ad2
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
# Hijing
/**
@page Hijing_i_page
@author Georgios Stavropoulos (George.Stavropoulos@cern.ch)
Author: Georgios Stavropoulos (George.Stavropoulos@cern.ch)
Documentation for the Hijing MC can be found here:
http://www-nsdth.lbl.gov/~xnwang/hijing/index.html
The Hijing interface documentation and explanations how to use Hijing in Athena framework is described here:
https://svnweb.cern.ch/trac/atlasoff/browser/Generators/Hijing_i/trunk/doc/Hijing.pdf
*/
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment