-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathglossary.html
More file actions
308 lines (301 loc) · 13.4 KB
/
glossary.html
File metadata and controls
308 lines (301 loc) · 13.4 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
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Glossary — DataCatalogDocs 0.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="canonical" href="https://dune.github.io/DataCatalogDocs/glossary.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Template for minimal metadata for a raw data file" href="template_input.html" />
<link rel="prev" title="Metadata categories and samweb->metacat conversion" href="metadatameaning.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="template_input.html" title="Template for minimal metadata for a raw data file"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="metadatameaning.html" title="Metadata categories and samweb->metacat conversion"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Glossary</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="glossary">
<span id="id1"></span><h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this heading">¶</a></h1>
<p>Incomplete list of keys used</p>
<p><strong>Keys must be lower case</strong> values can be either.</p>
<div class="section" id="minimal-terms-for-raw-and-processed-data">
<h2>Minimal terms for raw and processed data<a class="headerlink" href="#minimal-terms-for-raw-and-processed-data" title="Permalink to this heading">¶</a></h2>
<p><cite>[]</cite> denotes fields automatically filled in by the system</p>
<dl class="field-list simple">
<dt class="field-odd">name</dt>
<dd class="field-odd"><p>File name</p>
</dd>
<dt class="field-even">namespace</dt>
<dd class="field-even"><p>Metacat namespace for file</p>
</dd>
<dt class="field-odd">checksums</dt>
<dd class="field-odd"><p>dictionary of checksums - adler32 is the default</p>
</dd>
<dt class="field-even"><cite>[created_timestamp]</cite></dt>
<dd class="field-even"><p>Unix timestamp for when file was cataloged</p>
</dd>
<dt class="field-odd">creator</dt>
<dd class="field-odd"><p>account that created the file</p>
</dd>
<dt class="field-even">size</dt>
<dd class="field-even"><p>size in bytes</p>
</dd>
<dt class="field-odd"><cite>[fid]</cite></dt>
<dd class="field-odd"><p>hash-name for the file - equivalent to namespace:name</p>
</dd>
<dt class="field-even"><cite>[retired]</cite></dt>
<dd class="field-even"><p>has this file been retired?</p>
</dd>
<dt class="field-odd"><cite>[retired_by]</cite></dt>
<dd class="field-odd"><p>who did it?</p>
</dd>
<dt class="field-even"><cite>[retired_timestamp]</cite></dt>
<dd class="field-even"><p>when was it retired</p>
</dd>
<dt class="field-odd"><cite>[updated_by]</cite></dt>
<dd class="field-odd"><p>who has updated this catalog entry?</p>
</dd>
<dt class="field-even"><cite>[updated_timestamp]</cite></dt>
<dd class="field-even"><p>when did they do it?</p>
</dd>
<dt class="field-odd">parents</dt>
<dd class="field-odd"><p>[The files that this file was produced from, you need to declare parents when declaring child files]</p>
</dd>
<dt class="field-even"><cite>[children]</cite></dt>
<dd class="field-even"><p>[list of files that are derived from this file - autogenerated when you declare the child as having parents]</p>
</dd>
<dt class="field-odd">metadata</dt>
<dd class="field-odd"><p>description of file contents with this content</p>
</dd>
</dl>
<div class="section" id="generally-required">
<h3>generally required<a class="headerlink" href="#generally-required" title="Permalink to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">core.data_stream</dt>
<dd class="field-odd"><p>type of data taking (commissioning, calibration, test, physics, cosmics)</p>
</dd>
<dt class="field-even">core.data_tier</dt>
<dd class="field-even"><p>type of data, generally indicates steps in a processing sequence (raw, g4, )</p>
</dd>
<dt class="field-odd">core.event_count</dt>
<dd class="field-odd"><p>number of events in the file</p>
</dd>
<dt class="field-even">core.file_content_status</dt>
<dd class="field-even"><p>status of the file - default is “good”</p>
</dd>
<dt class="field-odd">core.file_format</dt>
<dd class="field-odd"><p>format of the data (hdf5, root)</p>
</dd>
<dt class="field-even">core.file_type</dt>
<dd class="field-even"><p>flag to tell mc from data, (detector or mc)</p>
</dd>
<dt class="field-odd">core.run_type</dt>
<dd class="field-odd"><p>which detector took the data “protodune-sp, hd-fardet …”</p>
</dd>
<dt class="field-even">core.runs</dt>
<dd class="field-even"><p>[list of runs]</p>
</dd>
<dt class="field-odd">core.runs_subruns</dt>
<dd class="field-odd"><p>[list of subruns in run*100000+subrun format]</p>
</dd>
<dt class="field-even">retention.status</dt>
<dd class="field-even"><p>should be “active” flag to tell if the file is being used and should be retained</p>
</dd>
<dt class="field-odd">retention.class</dt>
<dd class="field-odd"><p>flag used to determine retention status (physics, test, …)</p>
</dd>
</dl>
</div>
<div class="section" id="optional-but-useful">
<h3>optional but useful<a class="headerlink" href="#optional-but-useful" title="Permalink to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd"><em>core.start_time</em></dt>
<dd class="field-odd"><p>unix UTC time at which the process that created the file started</p>
</dd>
<dt class="field-even"><em>core.end_time</em></dt>
<dd class="field-even"><p>unix UTC time at which the process that created the file ended -</p>
</dd>
<dt class="field-odd"><em>core.events</em></dt>
<dd class="field-odd"><p>[list of events in the file], not useful for multiple runs</p>
</dd>
<dt class="field-even"><em>core.first_event_number</em></dt>
<dd class="field-even"><p>first event number</p>
</dd>
<dt class="field-odd"><em>core.last_event_number</em></dt>
<dd class="field-odd"><p>last event number</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="additional-terms-used-for-reconstruction-and-simulation">
<h2>Additional terms used for reconstruction and simulation<a class="headerlink" href="#additional-terms-used-for-reconstruction-and-simulation" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">dune.campaign</dt>
<dd class="field-odd"><p>A big scale activity used for production - examples are PDSPProd4a and fd_mc_2023a_reco2</p>
</dd>
<dt class="field-even">dune.requestid</dt>
<dd class="field-even"><p>The formal request id for the campaign in the system</p>
</dd>
<dt class="field-odd">dune.config_file</dt>
<dd class="field-odd"><p>The top level configuration used to produce this file</p>
</dd>
<dt class="field-even">dune.workflow</dt>
<dd class="field-even"><p>a description of the workflow that produced this file - produced by the JustIn system</p>
</dd>
<dt class="field-odd">dune.output_status</dt>
<dd class="field-odd"><p>the value should be “confirmed” - this tells you that the output exists</p>
</dd>
<dt class="field-even">core.application.family</dt>
<dd class="field-even"><p>broad description of the application (art/edepsim)</p>
</dd>
<dt class="field-odd">core.application.name</dt>
<dd class="field-odd"><p>the specific application, reco1/reco2/detsim…</p>
</dd>
<dt class="field-even">core.application.version</dt>
<dd class="field-even"><p>the DUNESW version</p>
</dd>
<dt class="field-odd">origin.applications.config_files</dt>
<dd class="field-odd"><p>dictionary describing the fcl files for a processing chain.</p>
</dd>
</dl>
</div>
<div class="section" id="minimal-monte-carlo-terms">
<h2>Minimal Monte Carlo terms<a class="headerlink" href="#minimal-monte-carlo-terms" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">core.group</dt>
<dd class="field-odd"><p>Should be <cite>dune</cite> or a physics group</p>
</dd>
<dt class="field-even">dune_mc.gen_fcl_filename</dt>
<dd class="field-even"><p>tells you the generator fcl file so you know what kind of mc it is.</p>
</dd>
<dt class="field-odd">dune_mc.geometry_version</dt>
<dd class="field-odd"><p>the geometry version used</p>
</dd>
<dt class="field-even">dune_mc.generators</dt>
<dd class="field-even"><p></p></dd>
</dl>
</div>
<div class="section" id="mc-terms-specific-to-particular-detectors">
<h2>MC terms specific to particular detectors<a class="headerlink" href="#mc-terms-specific-to-particular-detectors" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">dune_mc.liquid_flow</dt>
<dd class="field-odd"><p></p></dd>
<dt class="field-even">dune_mc.electron_lifetime</dt>
<dd class="field-even"><p>PD/FD - electron lifetime</p>
</dd>
<dt class="field-odd">dune_mc.space_charge</dt>
<dd class="field-odd"><p>PD/FD - space charge</p>
</dd>
<dt class="field-even">dune_mc.with_cosmics</dt>
<dd class="field-even"><p>PD/FD - cosmics as well as beam</p>
</dd>
<dt class="field-odd">Beam.momentum</dt>
<dd class="field-odd"><p>PD/FD - beam momentum in GeV/c</p>
</dd>
<dt class="field-even">Beam.polarity</dt>
<dd class="field-even"><p>PD/FD - polarity of beam</p>
</dd>
</dl>
<p>there may be others in future.</p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Glossary</a><ul>
<li><a class="reference internal" href="#minimal-terms-for-raw-and-processed-data">Minimal terms for raw and processed data</a><ul>
<li><a class="reference internal" href="#generally-required">generally required</a></li>
<li><a class="reference internal" href="#optional-but-useful">optional but useful</a></li>
</ul>
</li>
<li><a class="reference internal" href="#additional-terms-used-for-reconstruction-and-simulation">Additional terms used for reconstruction and simulation</a></li>
<li><a class="reference internal" href="#minimal-monte-carlo-terms">Minimal Monte Carlo terms</a></li>
<li><a class="reference internal" href="#mc-terms-specific-to-particular-detectors">MC terms specific to particular detectors</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="metadatameaning.html"
title="previous chapter">Metadata categories and samweb->metacat conversion</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="template_input.html"
title="next chapter">Template for minimal metadata for a raw data file</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/glossary.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="template_input.html" title="Template for minimal metadata for a raw data file"
>next</a> |</li>
<li class="right" >
<a href="metadatameaning.html" title="Metadata categories and samweb->metacat conversion"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Glossary</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2023, Fermi National Accelerator Laboratory.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
</html>