Richard Dubois wrote:
>
> I have modified the 'Code Doc' link on our LCD home page to point to a
> roadmap and have started a Root tutorial. Could you please take a look
> at the doc and give suggestions on improvements?
Here are a few.
Joanne
1. Roadmap should include indication that there is an input parameter
file for fastMC as well as the StdHep input.
2. There should be a page describing the format of the parameter files
including
* introductory paragraph stating in general terms what's in
the file
* Formal description of format, similar in style to what's in
the page describing ASCII Output File Format
* inclusion of or link to actual parameter file(s)
3. The name "StdHep output file" is at least mildly confusing, since
(as indicated) the same file is also used as input to other processes.
Is "StdHep particle file" any better?
4. Description of fastMC
http://www-sldnt.slac.stanford.edu/nld/documentation/fastmc/
has incorrect argument list -- delete references to separate
detector-type argument.
5. Ascii file output format description
http://www-sldnt.slac.stanford.edu/nld/ascii.htm
Needs to be updated (e.g., to include Cluster output).
Maybe should also include or point to extracts of real output for
each system.
How about modifying the introductory paragraph to this page to say
in general terms what the file includes and where it comes from?
For at least some readers, this is probably all the information
they want. E.g.,
Ascii output files containing "events" are produced by the Gismo
full simulation, by fastMC, and ultimately will be produced by the
full reconstruction as well. The types of data present for each
event in the file depend on the generating program, but are always
a subset of the following:
MC particle information (Gismo, fastMC, full recon)
Calorimeter hit information (Gismo, full recon)
Tracker information (Gismo, fastMC, full recon)
Calorimeter cluster information (fastMC, full recon)
In the detailed description below, subsystems are alphabetically
ordered by name. Their data is delimited by their name as the
first line and 'end' as the last. See here for the pre-November '98
format.
6. We should aim for structuring pages similarly where appropriate.
For example, pages describing programs (FastMC page, Full Simulation
page) will tend to contain information in similar categories (what
the code does, what input and outputs are, what other packages are
required,..) so the pages should have a similar organization. The
pages describing files (e.g. one for ascii output, one for fastMC
parameters, one for Detector.ini) should share another organizational
structure.
|