-
Notifications
You must be signed in to change notification settings - Fork 1
/
naming_conventions.html
179 lines (150 loc) · 7.79 KB
/
naming_conventions.html
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<!--#include FILE="./header.inc"-->
<body>
<!--#include FILE="./navigation.inc"-->
<div id="MainIn2ColumnPage">
<div CLASS="clsInsidePageHeader"> GENIE release, physics configuration and tune naming convention</div>
<br />
<div id="InsidePageSectionHeader">
GENIE/Generator versioning scheme
</div>
<div id="InsidePageSectionBody">
GENIE/Generator releases are numbered with 3 dot separated integers as <B>i.j.k</B>, where the
integers i,j,k correspond to the major, minor and revision number respectively.
The corresponding SVN tag for version i.j.k is <B>R-i_j_k</B>
(for example, GENIE version 2.0.2 is tagged as R-2_0_2).
</div>
<br />
<div id="InsidePageSectionHeader">
GENIE/Generator version number semantics
</div>
<div id="InsidePageSectionBody">
<ul>
<li>
Versions with even minor number (eg 2.4.*)
correspond to stable, fully validated physics/production releases. </li>
<li>
Versions with odd minor number (eg 2.3.*, 2.5.*) correspond to public `beta'/ candidate releases. </li>
<li>
Tagged versions always have an even revision number (eg 2.2.2 is a revision of the 2.2.0 physics / production
release whereas 2.3.2, 2.3.4, 2.3.6,... are `candidate' releases for the 2.4.0 physics / production release). </li>
</ul>
</div>
<br />
<div id="InsidePageSectionHeader">
GENIE/Generator codenames
</div>
<div id="InsidePageSectionBody">
The major production-quality releases of the GENIE/Generator product are code-named after
<A href="http://en.wikipedia.org/wiki/List_of_extinct_animals#Modern_extinctions">
modern extinct</A> or
<A href="http://en.wikipedia.org/wiki/Endangered_species"> endangered</A> species
(series of production releases:
<A href="http://en.wikipedia.org/wiki/Great_Auk"> <b>A</b>uk</A>,
<A href="https://www.wwf.org.uk/wildlife/polar-bears"> <b>B</b>ear (polar)</A>,
<A href="http://www.nature.ca/NOTEBOOKS/ENGLISH/echeetah.htm"><b>C</b>heetah</A>,
<A href="https://www.worldwildlife.org/species/dugong"> <b>D</b>ugong</A>,...
).
</div>
<br />
<div id="InsidePageSectionHeader">
GENIE/Generator release qualifiers
</div>
<div id="InsidePageSectionBody">
The GENIE releases are marked as:
<ul>
<li> <B><I CLASS="clsFGreen">pro</I></B> :
<br />
Validated production-quality versions recommended for physics studies. </li>
<li> <B><I CLASS="clsFBlue"> old</I></B> :
<br />
Older production versions that have been greatly superseeded by newer versions.
These versions become <b>unsupported</b>.
<!--
We appreciate that experiments get highly attached on specific versions due to the
enormous amount of work invested in generating high-statistics samples and in calculating
MC-dependent corrections and systematics.
We strive to support as many physics versions as reasonably possible.
-->
The typical lifetime of `physics' versions is of the order of 18-24 months. </li>
<li> <B><I CLASS="clsFRed"> rc </I></B> :
<br />
Release candidates. Please use for testing new models and features,
but avoid using for physics studies. </li>
<li> <B><I CLASS="clsFOrange"> special</I></B> :
<br />
Special releases prepared for a particular study, or an event such as a GENIE tutorial or a summer school.
Avoid using outside the intended context. </li>
</ul>
</div>
<br />
<div id="InsidePageSectionHeader">
GENIE/Generator comprehensive model configurations
</div>
<div id="InsidePageSectionBody">
Starting from v3.0.0, with the deployment of multiple comprehensive configurations (CMCs) and tunes,
and the addition of a `--tune' argument in several apps, GENIE adopted the following uniform
naming convention for its model configurations and tunes:
<br />
<br />
A comprehensive model configuration is identified by a 7-character string in the form
<h3 style="text-align:center;"> <b> Gdd_MMv </b> </h3>
where
<ol type="1">
<li>
<b>G</b> is a capital letter that identifies the author of the tune.
The default value is G (for the GENIE collaboration).
</li>
<li>
<b>dd</b> is a number describing the year during which the model configuration was developed.
</li>
<li>
<b>MM</b> is a number (00, 01, 02, ...) identifying a model configuration branch.
</li>
<li>
<b>v</b> is a character (a, b, c, ...) enumerating variations / offshoots of a model configuration branch.
</li>
</ol>
<br />
<b>Note on test configurations</b>:
<br />
<i>Test</i> comprehensive model configurations being developed, validated and tuned for deployment in future releases
may be created temporarily and appear in public releases.
This would allow users to experiment with early versions of these comprehensive models,
making sure that these experimental models and their features are properly configured by GENIE.
These configurations may not necessarily follow the above naming convention and
should be identified by the use of an initial <b>GTEST</b>.
Users are warned that <i>test</i> comprehensive model configurations may not be fully validated or tuned,
and that their very definition may subject to changes before they emerge as an officially supported tune.
We welcome feedback on these early snapshots of future model configurations but, for as long as they are classified as test
configurations, support will be limited and we may not prioritise bug-fix revisions to address issues in test configurations.
</div>
<br />
<div id="InsidePageSectionHeader">
GENIE/Generator tunes
</div>
<div id="InsidePageSectionBody">
Once a comprehensive model configuration is defined, a number of different tunes may be produced.
Each distinct choice of a) fit datasets and dataset weighting scheme, b) parameters of interest and nuisance parameters,
and c) prior constraints, leads to a different tune. A tune is identified by the model configuration name, and additional
information enumerating the parameters and datasets. This is a 14-character string in the form
<h3 style="text-align:center;"> <b> Gdd_MMv_PP_xxx </b> </h3>
where
<ol type="1">
<li> <b>Gdd_MMv</b> describes the model configuration (see above).
</li>
<li> <b>PP</b> is a number identifying the set of tuned parameters.
This parameter set is defined uniquely only in the context of a particular model configuration.
The number 00 indicates that a model configuration has not been tuned by GENIE.
</li>
<li> <b>xxx</b> is a number that identifies the dataset used for the model configuration tuning.
This may include a unique set weights associated with each component dataset.
The number 00 indicates that a model configuration has not been tuned by GENIE.
</li>
</ol>
</div>
</div> <!-- main -->
<!--#include FILE="./footer.inc"-->
</body>
</html>