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
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Global attributes — HARP 1.5 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="next" title="Variable attributes" href="variable_attributes.html" />
<link rel="prev" title="Dimensions" href="dimensions.html" />
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> HARP
</a>
<div class="version">
1.5
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Conventions</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="datatypes.html">Data types</a></li>
<li class="toctree-l2"><a class="reference internal" href="dimensions.html">Dimensions</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Global attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="variable_attributes.html">Variable attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="variables.html">Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="variable_names.html">Variable names</a></li>
<li class="toctree-l2"><a class="reference internal" href="categorical_variables.html">Categorical Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="datetime.html">Datetime values</a></li>
<li class="toctree-l2"><a class="reference internal" href="filenames.html">File naming</a></li>
<li class="toctree-l2"><a class="reference internal" href="netcdf3.html">netCDF-3</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf4.html">HDF4</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf5.html">HDF5/netCDF-4</a></li>
<li class="toctree-l2"><a class="reference internal" href="compatibility.html">Compatibility with other standards</a></li>
<li class="toctree-l2"><a class="reference internal" href="collocation_result.html">Collocation result file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../algorithms/index.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../operations.html">Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ingestions/index.html">Ingestion definitions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libharp.html">C library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../idl.html">IDL interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../matlab.html">MATLAB interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../python.html">Python interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tools.html">Command line tools</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">HARP</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">Conventions</a> »</li>
<li>Global attributes</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="global-attributes">
<h1>Global attributes</h1>
<p>The HARP format defines the following global attributes:</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">Conventions</span></code> string</dt>
<dd>This attribute should follow the netCDF convention and should contain <code class="docutils literal notranslate"><span class="pre">HARP-1.0</span></code> in its value to indicate that the
file conforms to the HARP data format conventions.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">history</span></code> string (optional)</dt>
<dd>This attribute is used by all HARP tools to keep a trace of the operations performed on a product. Each time a command
is performed on a HARP file the full command line is appended to this attribute (using a newline separator between
commands). The command line is prepended by the current UTC time and the version of HARP (using the format <code class="docutils literal notranslate"><span class="pre">YYY-MM-DDThh:mm:ssZ</span> <span class="pre">[harp-x.y]</span> <span class="pre"><command</span> <span class="pre">line></span></code>). This usage is in line with the general netCDF conventions for this attribute.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">source_product</span></code> string (optional)</dt>
<dd>This attribute will hold the name of the original product in case the HARP file was converted using <code class="docutils literal notranslate"><span class="pre">harpconvert</span></code>.
This approach makes it possible to use your own file naming approach for HARP files without losing trace of which
original product files the data came from.
Note that this attribute value is used as the main source to uniquely identify a product within a dataset.
Only if the attribute is absent then the current filename of the product will be used as product id within a dataset.
It is therefore important that the value of <code class="docutils literal notranslate"><span class="pre">source_product</span></code> (or, if absent, the current filename) is unique within
a dataset to allow the product to be uniquely identified. Tools such as <code class="docutils literal notranslate"><span class="pre">harpcollocate</span></code> rely on this.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">datetime_start</span></code> double (optional)</dt>
<dd>This attribute is mandatory if the file is to be used with <code class="docutils literal notranslate"><span class="pre">harpcollocate</span></code>. It allows for quick extraction of the
time range of the product. The attribute should be a scalar double precision floating point value giving the
<code class="docutils literal notranslate"><span class="pre">datetime</span></code> of the first measurement as <code class="docutils literal notranslate"><span class="pre">days</span> <span class="pre">since</span> <span class="pre">2000-01-01</span></code> (using the fractional part to represent time-of-
day). When exporting data, HARP will itself generate the value by looking at the minimum value of the available
<code class="docutils literal notranslate"><span class="pre">datetime_start</span></code> (or, if absent, <code class="docutils literal notranslate"><span class="pre">datetime</span></code>) variable.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">datetime_stop</span></code> double (optional)</dt>
<dd>This attribute is mandatory if the file is to be used with <code class="docutils literal notranslate"><span class="pre">harpcollocate</span></code>. It allows for quick extraction of the
time range of the product. The attribute should be a scalar double precision floating point value giving the
<code class="docutils literal notranslate"><span class="pre">datetime</span></code> of the last measurement as <code class="docutils literal notranslate"><span class="pre">days</span> <span class="pre">since</span> <span class="pre">2000-01-01</span></code> (using the fractional part to represent time-of-
day). When exporting data, HARP will itself generate the value by looking at the maximum value of the available
<code class="docutils literal notranslate"><span class="pre">datetime_stop</span></code> (or, if absent, <code class="docutils literal notranslate"><span class="pre">datetime</span></code>) variable.</dd>
</dl>
<p>Note that the <code class="docutils literal notranslate"><span class="pre">Conventions</span></code>, <code class="docutils literal notranslate"><span class="pre">datetime_start</span></code>, and <code class="docutils literal notranslate"><span class="pre">datetime_stop</span></code> attributes are only used inside files.
For the in-memory representation (in C, Python, etc.) only the <code class="docutils literal notranslate"><span class="pre">history</span></code> and <code class="docutils literal notranslate"><span class="pre">source_product</span></code> attributes are present.</p>
<p>Note that files using the HARP data format can include global attributes in addition to the ones mentioned above.
However, such attributes will be ignored when the product is imported.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="variable_attributes.html" class="btn btn-neutral float-right" title="Variable attributes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="dimensions.html" class="btn btn-neutral" title="Dimensions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015-2018 S&T, The Netherlands
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script async="async" type="text/javascript" src="/usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
