-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmetadatameaning.html
More file actions
373 lines (366 loc) · 12.8 KB
/
metadatameaning.html
File metadata and controls
373 lines (366 loc) · 12.8 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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Metadata categories and samweb->metacat conversion — 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/metadatameaning.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Glossary" href="glossary.html" />
<link rel="prev" title="Sam to Metacat Conversion guide" href="sam2metacat.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="glossary.html" title="Glossary"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="sam2metacat.html" title="Sam to Metacat Conversion guide"
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="">Metadata categories and samweb->metacat conversion</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="metadata-categories-and-samweb-metacat-conversion">
<h1>Metadata categories and samweb->metacat conversion<a class="headerlink" href="#metadata-categories-and-samweb-metacat-conversion" title="Permalink to this heading">¶</a></h1>
<p>Samweb and metacat turn out to need quite a lot of information to describe a file.</p>
<p>There is</p>
<ul class="simple">
<li><p>basic information about the file as a file - size, creation, creator, checksum</p></li>
<li><p>core information about the file contents such as run_number, data tier, and trigger stream that are needed to define data samples. Most of these are now in the core category in metacat. If it is a core item, you probably should be filling it.</p></li>
<li><p>data that is useful to know - provenance (what was it created from, how, who did it)</p></li>
<li><p>additional information that may be specific to a given physics group or extra details on reconstruction/simulation parameters.</p></li>
</ul>
<p><a class="reference internal" href="template.html"><span class="doc">Template for minimal metadata for a file</span></a> shows a metacat example for a raw data file - sam fields are similar with <cite>core.</cite> removed</p>
<p><a class="reference internal" href="mctemplate.html"><span class="doc">Template for minimal metadata for a Monte Carlo file</span></a> shows a metacat example for a monte carlo file</p>
<p>Both sam and metacat put the more detailed information in objects with <type>.<subtype> format. Metacat extends this to <category>.<sub>.<sub …>.<name></p>
<div class="section" id="here-is-a-table-to-convert-fields">
<h2>Here is a table to convert fields<a class="headerlink" href="#here-is-a-table-to-convert-fields" title="Permalink to this heading">¶</a></h2>
<table class="colwidths-given docutils align-default" id="id1">
<caption><span class="caption-text">metacat equivalents for sam fields</span><a class="headerlink" href="#id1" title="Permalink to this table">¶</a></caption>
<colgroup>
<col style="width: 30%" />
<col style="width: 30%" />
<col style="width: 40%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Metacat</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>Samweb</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>Basics</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>fid</p></td>
<td><p>int</p></td>
<td><p>file_id</p></td>
</tr>
<tr class="row-even"><td><p>namespace</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>name</p></td>
<td><p>string</p></td>
<td><p>file_name</p></td>
</tr>
<tr class="row-even"><td><p>creator</p></td>
<td><p>string</p></td>
<td><p>user</p></td>
</tr>
<tr class="row-odd"><td><p>created_timestamp</p></td>
<td><p>timestamp</p></td>
<td><p>create_date</p></td>
</tr>
<tr class="row-even"><td><p>size</p></td>
<td><p>int</p></td>
<td><p>file_size</p></td>
</tr>
<tr class="row-odd"><td><p>checksums</p></td>
<td><p>dictionary</p></td>
<td><p>check_sum (dict)</p></td>
</tr>
<tr class="row-even"><td><p>retired</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>retired_by</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>retired_timestamp</p></td>
<td><p>timestamp</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>updated_by</p></td>
<td><p>string</p></td>
<td><p>update_user</p></td>
</tr>
<tr class="row-even"><td><p>updated_timestamp</p></td>
<td><p>timestamp</p></td>
<td><p>update_date</p></td>
</tr>
<tr class="row-odd"><td><p>update_comment</p></td>
<td><p>blob</p></td>
<td></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>Core attributes</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>core.application.version</p></td>
<td><p>string</p></td>
<td><p>app_family</p></td>
</tr>
<tr class="row-even"><td><p>core.application.family</p></td>
<td><p>string</p></td>
<td><p>app_version</p></td>
</tr>
<tr class="row-odd"><td><p>core.application.name</p></td>
<td><p>string</p></td>
<td><p>app_name</p></td>
</tr>
<tr class="row-even"><td><p>core.event_count</p></td>
<td><p>int</p></td>
<td><p>event_count</p></td>
</tr>
<tr class="row-odd"><td><p>core.first_event_number</p></td>
<td><p>int</p></td>
<td><p>first_event</p></td>
</tr>
<tr class="row-even"><td><p>core.last_event_number</p></td>
<td><p>int</p></td>
<td><p>last_event</p></td>
</tr>
<tr class="row-odd"><td><p>core.start_time</p></td>
<td><p>timestamp</p></td>
<td><p>start_time</p></td>
</tr>
<tr class="row-even"><td><p>core.end_time</p></td>
<td><p>timestamp</p></td>
<td><p>end_time</p></td>
</tr>
<tr class="row-odd"><td><p>core.file_content_status</p></td>
<td><p>string</p></td>
<td><p>content_status</p></td>
</tr>
<tr class="row-even"><td><p>core.data_stream</p></td>
<td><p>string</p></td>
<td><p>data_stream</p></td>
</tr>
<tr class="row-odd"><td><p>core.data_tier</p></td>
<td><p>string</p></td>
<td><p>data_tier</p></td>
</tr>
<tr class="row-even"><td><p>core.events</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>core.file_type</p></td>
<td><p>text</p></td>
<td><p>file_type</p></td>
</tr>
<tr class="row-even"><td><p>core.file_format</p></td>
<td><p>text</p></td>
<td><p>file_format</p></td>
</tr>
<tr class="row-odd"><td><p>core.run_type</p></td>
<td><p>text</p></td>
<td><p>run_type</p></td>
</tr>
<tr class="row-even"><td><p>core.runs</p></td>
<td><p>array</p></td>
<td><p>run_number (integer part)</p></td>
</tr>
<tr class="row-odd"><td><p>core.runs_subruns</p></td>
<td><p>array</p></td>
<td><p>run_number (part past the decimal point)</p></td>
</tr>
<tr class="row-even"><td><p>core.raw_timestamp</p></td>
<td><p>timestamp</p></td>
<td></td>
</tr>
<tr class="row-odd"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>dune_mc.*</p></td>
<td><p>all types</p></td>
<td><p>DUNE_MC.*</p></td>
</tr>
<tr class="row-odd"><td><p>Retention/access keys</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>retention.status</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>retention.class</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>Additional attributes</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p><category>.<subcategory>.<name> …</p></td>
<td><p>string,int, bool, ….</p></td>
<td><p><category>.<name></p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="here-is-a-table-of-common-command-translations">
<h2>Here is a table of common command translations<a class="headerlink" href="#here-is-a-table-of-common-command-translations" title="Permalink to this heading">¶</a></h2>
<table class="colwidths-given docutils align-default" id="id2">
<caption><span class="caption-text">metacat equivalents for sam commands</span><a class="headerlink" href="#id2" title="Permalink to this table">¶</a></caption>
<colgroup>
<col style="width: 40%" />
<col style="width: 40%" />
<col style="width: 20%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>metacat</p></th>
<th class="head"><p>samweb</p></th>
<th class="head"><p>comment</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>metacat query ‘files from dnamespace:dataset where x=y’</p></td>
<td><p>samweb list-files ‘ x y ‘</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>??</p></td>
<td><p>samweb list-files –summary ‘x y’</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>metacat file show -m <namespace>:<filename></p></td>
<td><p>samweb get-metadata <filename></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>metacat query ‘files from dune:all with name=<filename>’</p></td>
<td></td>
<td><p>finds the namespace</p></td>
</tr>
</tbody>
</table>
</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="#">Metadata categories and samweb->metacat conversion</a><ul>
<li><a class="reference internal" href="#here-is-a-table-to-convert-fields">Here is a table to convert fields</a></li>
<li><a class="reference internal" href="#here-is-a-table-of-common-command-translations">Here is a table of common command translations</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="sam2metacat.html"
title="previous chapter">Sam to Metacat Conversion guide</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="glossary.html"
title="next chapter">Glossary</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/metadatameaning.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="glossary.html" title="Glossary"
>next</a> |</li>
<li class="right" >
<a href="sam2metacat.html" title="Sam to Metacat Conversion guide"
>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="">Metadata categories and samweb->metacat conversion</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>