Repository navigation
Expand file tree
/
Copy pathicaruscode.dox
More file actions
66 lines (50 loc) · 2.48 KB
/
Copy pathicaruscode.dox
File metadata and controls
66 lines (50 loc) · 2.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/**
@mainpage The ICARUS detector simulation and reconstruction software: `icaruscode` reference manual
This is the documentation of the ICARUS detector simulation and reconstruction
software, distributed in the main GIT repository `icaruscode`.
This software is powered by the @ref LArSoft "LArSoft toolkit", which has its
own documentation in Doxygen format.
That documentation is linked by the ICARUS documentation.
The documentation is automatically generated out of comments encoded in the
source files in Doxygen format.
@section ICARUSDocumentationSource Sources for ICARUS documentation
ICARUS documentation is scattered in places:
- [wiki][ICARUSwiki] in GitHub (old version in [Fermilab Redmine][ICARUSwikiOld])
offers guidelines, documents procedures, and much more; it tends to go outdated though;
- [SBN DocDB][SBNDocDB] (https://sbn-docdb.fnal.gov/cgi-bin/sso/DocumentDatabase)
contains plenty of information
- software reference manual (this one; [all versions: here][ICARUSDoxygenList]; [latest: here][ICARUSDoxygenLatest]) is a
reference guide for the use of specific ICARUS code objects.
- [ICARUS at work][ICARUSatWork] page is a hub for documentation on the detector and working groups
- the main repository of the software is now in [GitHub] as [`icaruscode` repository][ICARUSGitHub]
under the [SBNSoftware] umbrella;
the [SBN software documentation repository][SBNwiki] is also in GitHub
@section ICARUSDocumentationTopics ICARUS topics
- @ref ICARUSPMTTrigger "optical detector and trigger simulation"
- ... or browse the list of [doxygen groups](modules.html), or the [class list](classes.html)
@section ICARUSversions Documentation of other icaruscode software versions
This documentation pertains the version written above.
Others may be available: [check the list][ICARUSDoxygenList].
[LArSoft.org]:
http://www.larsoft.org
[ICARUSwiki]:
https://sbnsoftware.github.io/icaruscode_wiki/Wiki
[ICARUSwikiOld]:
https://cdcvs.fnal.gov/redmine/projects/icaruscode/wiki
[SBNDocDB]:
https://sbn-docdb.fnal.gov/cgi-bin/sso/DocumentDatabase
[ICARUSatWork]:
https://icarus-exp.fnal.gov
[ICARUSDoxygenList]:
https://icarus-exp.fnal.gov/at_work/software/doc/icaruscode/versionlist.html
[ICARUSDoxygenLatest]:
https://icarus-exp.fnal.gov/at_work/software/doc/icaruscode/latest
[ICARUSGitHub]:
https://github.com/SBNSoftware/icaruscode
[SBNSoftware]:
https://github.com/SBNSoftware
[SBNwiki]:
https://github.com/SBNSoftware/SBNSoftware.github.io
[GitHub]:
https://github.com
*/