From Daya Bay
|Offline Documentation: [Offline Category] [FAQ] [Howto] [Reference] [Manual]|
| This article is part |
of the Offline Documentation
Offline Documentation Portal
This is the main offline software documentation "portal". It collects links to sub-portals to and other available documentation.
Offline Documentation organization
All offline software documentation topics should follow the conventions outlined in Meta:Offline_Documentation.
There are four "sub-portals" collecting documentation of a certain type. They are:
Every page can be in zero or more categories. You can browse through all the categories.
Use the "Special:Search" function on the left hand side of every page.
Anonymous Comment Box
Add your requests for documentation in the OfflineCommentBox.
There are two mailing lists that can provide help.
- address: firstname.lastname@example.org and archives
- adress: email@example.com and archives
Some things to know about the lists:
- Please send questions to the list instead of individual experts. It is very likely that if you have a question someone else is interested in the answer as well.
- All the experts are on both lists, so you only need to pick one send your question and don't worry about choosing the "wrong" one.
- Do not worry about asking too many, too simple or "wrong" questions. The experts are happy to help.
NuWa code browser
There are various utilities and command line programs that provide help.
Comments made in the source are used by Doxygen to generate reference documentation. It also produces easy to browse source code.
Different sites have set up Doxygen. They differ in what features are offered and what top-level organization exists.
(First in list is more likely to be up-to-date than second, etc.)
- BNL Doxygen, browse
- NUU Doxygen and NTU proxy, browse.
- PDSF Doxygen, browse
- CalTech Doxygen, browse
- IIT Doxygen, browse, search
Trac is for bug/issue tracking but also has nice features for exploring the code. See the topic on trac for more info.
Besides software issues, Trac can be used to report problems with the documentation. See the open tickets attributed to dybgaudi//Documentation for things needing work.
- List of successful daily builds.
- The revision number is sufficient to build from scratch using dybinst.
- Details on how successful daily builds are defined.
There have been a few tutorial sessions from past collaboration meetings.
There have also been offline software workshops. These are more design oriented than direct tutorials but may have useful background material.
- April 2008 @ BNL
- IHEP December 2009
- Analysis Workshop at UW May 2010
- Analysis Workshop at Weihai July 2010
- Caltech February 2011
- LBL May 2011
- IHEP May 2011 summary
- IHEP July 2011
As the code changes the tutorial instructions may differ from the original talks in DocDB. These links should provide current instructions for the tutorials.
- Diving In
- Job Configuration and nuwa.py
- NuWa Geometry
- Generators: Using GenTools
- ElecSim: The NuWa Electronics Simulation
- Electronics Example and Using Your Own Project
- Applying PMT maximal quantum efficiency before tracking
There are many tech notes in DocDB that documents the design phase. Some useful ones are listed below, most recent first.
- Low level file input/output.
- HeaderObject base class for most data objects in the event store.
- The detector modeling (DetDesc) and simulation (DetSim), more on DetSim and DetDesc.
- Generating kinematics (GenTools)
- "1 Second to live" describes the analysis time window.
- "15 minutes of fame" describes how to simulate realistic data with different kinematics properly mixed.
Other Daya Bay Software Links
- Zai Nar? (Where is?) Page of links to Daya Bay stuff: where is? 在哪里
- Physics Software Rant a must-read for developers of physics software by the one-time Debian packager of GEANT3/CERNLIB.
|Offline Software Documentation: [Offline Categories] [FAQ] [Offline Documentation Category]|