WSL/SLF GitLab Repository

meteoio_timeseries_input.xml 38.8 KB
Newer Older
1
2
<!--
/*****************************************************************************/
3
/*  Copyright 2020 WSL Institute for Snow and Avalanche Research  SLF-DAVOS  */
4
5
6
/*****************************************************************************/
/* This file is part of INIshell.
INIshell is free software: you can redistribute it and/or modify
7
it under the terms of the GNU General Public License as published by
8
9
10
11
12
13
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

INIshell is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
GNU General Public License for more details.
15

16
17
You should have received a copy of the GNU General Public License
along with INIshell.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
21
*/
-->

<!--
22
23
INIshell include file for timeseries input plugin definitions
Please include meteoio_parametergroups before use!
24
25
26
27
28
29
30
-->

<inishell_include>

	<!-- Alternative panel: METEOIO_TS_IN -->
	<parametergroup name="METEOIO_TS_IN">
		<!-- it's nice to give defaults to non-optional keys (no 'unsaved changes' warning: -->
31
32
33
		<parameter type="helptext" wrap="true">
			<help>The plugins in the dropdown menu below that are italicized require third-party libraries that might not be installed on your system.</help>
		</parameter>
34
		<parameter key="METEO" label="Select METEO data plugin:" type="alternative" optional="false" default="SMET" pre-generate="false">
35
			<option value="A3D">
36
37
38
				<parameter key="METEOPATH" type="path" optional="false">
					<help>Path to the meteorological files; this path must exist, it won't be created</help>
				</parameter>
39
				<help>Original Alpine3D meteo files [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/a3d.html&quot;&gt;more…&lt;/a&gt;]</help>
40
			</option>
41
			<option value="ALPUG">
42
				<reference name="ALPUG_IN"/>
43
				<help>Data files generated by the ALPUG meteo stations [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/alpug.html&quot;&gt;more…&lt;/a&gt;]</help>
44
			</option>
45
			<option value="ARGOS">
Mathias Bavay's avatar
Mathias Bavay committed
46
				<reference name="ARGOS_IN"/>
47
				<help>Data files transmitted by the ARGOS system [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/argosio.html&quot;&gt;more…&lt;/a&gt;]</help>
Mathias Bavay's avatar
Mathias Bavay committed
48
			</option>
49
			<option value="COSMOXML" italic="true">
50
				<reference name="COSMO_IN"/>
51
				<help>MeteoSwiss COSMO's postprocessing XML format [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/cosmoxml.html&quot;&gt;more…&lt;/a&gt;]</help>
52
			</option>
53
			<option value="CSV" bold="true">
54
				<reference name="CSV_IN"/>
55
				<help>Comma separated files [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/csvio.html&quot;&gt;more…&lt;/a&gt;]</help>
56
			</option>
57
			<option value="DBO" italic="true">
58
				<reference name="DBO_IN"/>
59
				<help>Connects to SLF's DBO web service interface [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/dbo.html&quot;&gt;more…&lt;/a&gt;]</help>
60
			</option>
61
			<option value="GEOTOP">
62
				<reference name="GEOTOP_IN"/>
63
				<help>GeoTop meteo files [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/geotop.html&quot;&gt;more…&lt;/a&gt;]</help>
64
			</option>
65
			<option value="GOES">
66
				<reference name="GOES_IN"/>
67
				<help>Meteo files transmitted by the GOES satellites [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/goesio.html&quot;&gt;more…&lt;/a&gt;]</help>
68
			</option>
69
			<option value="GRIB" italic="true">
70
				<reference name="GRIB_METEO_IN"/>
71
				<help>GRIB meteo grid files [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/gribio.html&quot;&gt;more…&lt;/a&gt;]</help>
72
			</option>
73
			<option value="IMIS" italic="true">
74
				<reference name="IMIS_IN" />
75
				<help>SLF's IMIS database [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/imis.html&quot;&gt;more…&lt;/a&gt;]</help>
76
			</option>
77
			<option value="NETCDF" bold="true" italic="true">
78
				<reference name="NETCDF_IN"/>
79
				<help>NetCDF grids and timeseries [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/netcdf.html&quot;&gt;more…&lt;/a&gt;]</help>
80
			</option>
81
			<option value="OSHD" italic="true">
82
				<reference name="OSHD_METEO_IN"/>
83
				<help>OSHD generated binary Matlab files [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/oshd.html&quot;&gt;more…&lt;/a&gt;]</help>
84
			</option>
85
			<o value="PMOD"><help>Raw data files from Pmod/Wrc [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/pmodio.html&quot;&gt;more…&lt;/a&gt;]</help></o>
86
			<option value="PSQL" italic="true">
87
				<reference name="PSQL_IN"/>
88
				<help>Connects to PostgreSQL database [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/psqlio.html&quot;&gt;more…&lt;/a&gt;]</help>
89
			</option>
90
			<option value="SASE" italic="true">
91
				<help>Connects to the SASE database [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/sase.html&quot;&gt;more…&lt;/a&gt;]</help>
92
			</option>
93
			<option value="SMET" bold="true">
94
				<reference name="SMET_IN"/>
95
				<help>SMET data files [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/smetio.html&quot;&gt;more…&lt;/a&gt;]</help>
96
			</option>
97
			<option value="SNOWPACK">
98
				<reference name="SNOWPACK_IN"/>
99
				<help>Original SNOWPACK meteo files [&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/snowpack.html&quot;&gt;more…&lt;/a&gt;]</help>
100
101
102
103
104
105
			</option>
			<help>See &lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/data_sources.html&quot;&gt;MeteoIO's help&lt;/a&gt; for more information</help>
		</parameter> <!-- end METEOIO_TS_IN -->
	</parametergroup>

	<!-- ALPUG -->
106
	<parametergroup name="ALPUG_IN">
107
108
109
		<parameter key="METEOPATH" type="path" mode="input" optional="false">
			<help>Path to the data files; this path MUST exist, it won't be created</help>
		</parameter>
110
		<reference name="STATIONGROUP_NAMES"/>
111
112
113
		<parameter key="METAFILE" type="file" mode="input" optional="false">
			<help>Absolute filename of the metadata file</help>
		</parameter>
114
		<parameter key="WRAP_MONTH" type="number" format="integer+" min="1" max="12" default="10" optional="false" notoggle="true">
115
116
117
118
119
120
			<help>month when a new file is started</help>
		</parameter>
		<parameter key="ALPUG_FIELDS" type="text" default="%,%,ID,timestamp,VW,VW_MAX,DW,TA,RH, RSWR,HS,%,%,%,%,%,TSG,%,%,%,TSS,ISWR,P" size="large" optional="false">
			<help>Description of the fields (using % to mark the fields to skip)</help>
		</parameter>
	</parametergroup>
Michael Reisecker's avatar
Michael Reisecker committed
121

Mathias Bavay's avatar
Mathias Bavay committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
	<!-- ARGOS -->
	<parametergroup name="ARGOS_IN">
		<parameter key="METEOPATH" type="path" optional="false">
			<help>directory where to read the data files from</help>
		</parameter>
		<parameter key="ARGOS_EXT" type="text" size="small">
			<help>extension of Argos data files to use when no FILE# keyword has been provided</help>
		</parameter>
		<parameter key="METEOPATH_RECURSIVE" type="alternative">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>when no METEOFILE# keyword has been defined, should all files under METEOPATH be searched recursively?</help>
		</parameter>
		<reference name="FILESGROUP"/>
		<parameter key="METAFILE" type="file" mode="input" optional="false">
			<help>an ini file that contains all the metadata, for each station that has to be read</help>
		</parameter>
		<parameter key="ARGOS_DEBUG" type="alternative">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>should extra (ie very verbose) information be displayed?</help>
		</parameter>
	</parametergroup>
145

146
147
148
149
150
151
152
153
154
155
156
157
158
	<!-- COSMO -->
	<parametergroup name="COSMO_IN">
		<parameter key="METEOPATH" type="path" optional="false">
			<help>Path to the data files; this path MUST exist, it won't be created</help>
		</parameter>
		<parameter key="METEO_PREFIX" type="text">
			<help>Specify the prefix that stands ahead of the numerical date in the filenames. This is used for
				filtering which files to read when reading a whole directory but also in any case to help extract the date
				of the first timestep from the filename.</help>
		</parameter>
		<parameter key="METEO_EXT" type="text" default=".xml" size="small">
			<help>Specify the extension of the input files (default ".xml", specify "none" to get an empty string</help>
		</parameter>
159
160
161
		<parameter key="METEOFILE" type="text">
			<help>Specify the XML file that contains the data (in &lt;code&gt;METEOPATH&lt;/code&gt;)</help>
		</parameter>
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
		<parameter key="IMIS_STATIONS" type="alternative" default="FALSE">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>Strip the provided station names of their number to fit the IMIS naming scheme with the COSMO-CH naming scheme</help>
		</parameter>
		<parameter key="USE_MODEL_LOC" type="alternative" default="TRUE">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>If set to false, the true station location (lat, lon, altitude) is used. Otherwise, it uses the model location (default)</help>
		</parameter>
		<parameter key="XML_ENCODING" type="alternative">
			<option value="UTF-8"/>
			<option value="UTF-16-LE"/>
			<option value="UTF-16-BE"/>
			<option value="UCS-4-LE"/>
			<option value="UCS-4-BE"/>
			<option value="UCS-4-2143"/>
			<option value="UCS-4-3412"/>
			<option value="UCS-2"/>
			<option value="EBCDIC"/>
			<option value="ISO-8859-1"/>
			<option value="ISO-8859-2"/>
			<option value="ISO-8859-3"/>
			<option value="ISO-8859-4"/>
			<option value="ISO-8859-5"/>
			<option value="ISO-8859-6"/>
			<option value="ISO-8859-7"/>
			<option value="ISO-8859-8"/>
			<option value="ISO-8859-9"/>
			<option value="ISO-2022-JP"/>
			<option value="SHIFT-JIS"/>
			<option value="EUC-JP"/>
			<option value="ASCII"/>
			<help>Force the input file encoding, overriding the file's own encoding declaration</help>
		</parameter>
		<reference name="STATIONGROUP_NAMES"/>
	</parametergroup>

200
201
202
203
204
	<!-- CSV -->
	<parametergroup name="CSV_IN">
		<parameter key="METEOPATH" type="path" optional="false">
			<help>Path to the csv files; this path must exist, it won't be created</help>
		</parameter>
205
		<parameter key="METEOPATH_RECURSIVE" type="alternative">
206
207
208
209
210
211
212
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>If set to true, &lt;code&gt;METEOPATH&lt;/code&gt; will be search recursively for data files</help>
		</parameter>
		<parameter key="CSV_FILE_EXTENSION" type="text" default=".csv" size="small">
			<help>When scanning a directory for all csv files, which extension to consider (only used when no &lt;code&gt;STATION&lt;/code&gt; key is defined)</help>
		</parameter>
213
		<parameter key="CSV_SILENT_ERRORS" type="alternative">
214
215
216
217
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>If set to true, lines that can not be read are silently ignored (has priority over &lt;code&gt;CSV_ERRORS_TO_NODATA&lt;/code&gt;)</help>
		</parameter>
218
		<parameter key="CSV_ERRORS_TO_NODATA" type="alternative">
219
220
221
222
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>If set to true, fields that can not be parsed are assigned &lt;code&gt;nodata&lt;/code&gt;</help>
		</parameter>
223

224
		<parameter key="CSV_DELIMITER" type="text" default="," size="small">
Mathias Bavay's avatar
Mathias Bavay committed
225
			<help>Field delimiter character (use &lt;code&gt;SPACE&lt;/code&gt; or &lt;code&gt;TAB&lt;/code&gt; for whitespaces)</help>
226
		</parameter>
227
		<parameter key="CSV_NODATA" type="text">
228
229
			<help>A value that should be interpreted as &lt;code&gt;nodata&lt;/code&gt;</help>
		</parameter>
230
231
232
		<parameter key="CSV_EXCLUDE_LINES" type="text" size="large" validate="^(?:\d+(?:\s\-\s\d+)?(?:\s?,\s)?)+$">
			<help>Exclude a comma delimited list of line ranges (line numbers separated by ' - ') such as &lt;i&gt;456 - 468&lt;/i&gt; or individual lines</help>
		</parameter>
233
234
235
		<parameter key="CSV_COMMENTS_MK" type="text" validate="^.$">
			<help>Single character to use as marker for comments in the input file (default: none)</help>
		</parameter>
236
237
		<parameter key="CSV_PURGE_CHARS" type="text" size="large" validate="^(?:\S|(\d{1,3})|(0[xX][0-9a-fA-F]{2}))(?:\s(\S|(\d{1,3})|(0[xX][0-9a-fA-F]{2})))*\s*$">
			<help>Exclude a space delimited list of characters, either directly provided or as decimal representation or as hexadecimal representation prefixed by &lt;i&gt;0x&lt;/i&gt;. Example: &lt;i&gt;0x40 " 13&lt;/i&gt;</help>
238
		</parameter>
239

240
		<frame caption="Header handling" color="#c4c4c4">
241
			<parameter key="CSV_NR_HEADERS" type="number" format="integer+" default="1" notoggle="true">
242
243
244
245
246
247
248
249
				<help>Number of header lines</help>
			</parameter>
			<parameter key="CSV_HEADER_DELIMITER" type="text" default="" size="small">
				<help>different field delimiter to use in header lines</help>
			</parameter>
			<parameter key="CSV_HEADER_REPEAT_MK" type="text" size="large">
				<help>A string that is used to signal another copy of the headers mixed with the data in the file (the matching is done anywhere in the line)</help>
			</parameter>
250
			<parameter key="CSV_UNITS_HEADERS" type="number" format="integer+" size="large" notoggle="true">
251
252
253
254
255
256
257
258
				<help>Header line providing the measurements units</help>
			</parameter>
			<parameter key="CSV_UNITS_OFFSET" type="text" size="large">
				<help>Offset to add to each value in order to convert it to SI, such as &lt;code&gt;0 0 273.15&lt;/code&gt;</help>
			</parameter>
			<parameter key="CSV_UNITS_MULTIPLIER" type="text" size="large">
				<help>Factor to multiply each value by, in order to convert it to SI, such as &lt;code&gt;1 1 0.01&lt;/code&gt;</help>
			</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
259
260
261
			<parameter key="CSV_UNITS" type="text" size="large">
				<help>Space delimited list of units to use for the columns (including the timestamp). No units is represented by "-". This can not be used together with units_offset / units multiplier</help>
			</parameter>
262
		</frame>
263

264
		<frame caption="Fields parsing" color="#c4c4c4">
265
			<parameter key="CSV_COLUMNS_HEADERS" type="number" format="integer+" notoggle="true">
266
267
268
				<help>header line number to interpret as columns headers</help>
			</parameter>
			<parameter key="CSV_FIELDS" type="text" size="large">
269
				<help>Provide a column header (if none is present or to overwrite it) such as &lt;code&gt;DATE TIME ID TA&lt;/code&gt;. See below for special field names related to Date/Time handling or in the &lt;a href="https://models.slf.ch/docserver/dev/meteoio/doc/html/csvio.html#csvio_metadata_field_types"&gt;documentation&lt;/a&gt; for more special field names.</help>
270
271
272
			</parameter>
			<parameter key="CSV_FILTER_ID" type="text" size="large">
				<help>if the data contains an "ID" column, which ID should be kept (all others will be rejected); default: station ID</help>
273
274
275
276
277
			</parameter>
			<parameter key="CSV_SKIP_FIELDS" type="text" size="large">
				<help>A space-delimited list of field to skip (first field is numbered 1). Keep in mind that when using parameters such as &lt;code&gt;UNITS_OFFSET&lt;/code&gt;, the skipped field MUST be taken into consideration (since even if a field is skipped, it is still present in the file!)</help>
			</parameter>
		</frame>
278

279
		<frame caption="Date/Time handling" color="#c4c4c4">
280
			<parameter type="helptext" wrap="true">
281
				<help>Date/Time information is either provided as strings that will be parsed (as one combined timestamp (DATETIME or TIMESTAMP) or as a date and a time field (DATE and TIME), see below) or as separate components: then the fields must be named (either from the headers or through the CSV_FIELDS key) as YEAR, JDAY (number of days since the begining of the year), MONTH, DAY, NTIME (numerical representation of time, for example 952 for 09:52), HOURS, MINUTES, SECONDS (if minutes or seconds are missing, they will be assumed to be zero).</help>
282
283
			</parameter>
			<parameter key="CSV_TIMESTAMP" type="alternative">
284
285
286
287
288
289
290
291
292
293
294
295
296
				<option value="COMBINED">
					<parameter key="CSV_DATETIME_SPEC" type="text" optional="false">
						<help>Mixed date and time format specification, such as &lt;code&gt;YYYY-MM-DDTHH24:MI:SS&lt;/code&gt;</help>
					</parameter>
				</option>
				<option value="SPLIT">
					<parameter key="CSV_DATE_SPEC" type="text" optional="false">
						<help>Date format specification, such as &lt;code&gt;YYYY-MM-DD&lt;/code&gt;</help>
					</parameter>
					<parameter key="CSV_TIME_SPEC" type="text" optional="false">
						<help>Time format specification, such as &lt;code&gt;HH24:MI:SS&lt;/code&gt;</help>
					</parameter>
				</option>
297
298
299
300
301
302
303
304
305
306
307
				<option value="DECIMAL">
					<parameter key="CSV_DECIMALDATE_TYPE" type="alternative" optional="false">
						<option value="EXCEL"/>
						<option value="MATLAB"/>
						<option value="RFC868"/>
						<option value="UNIX"/>
						<option value="JULIAN"/>
						<option value="MJULIAN"/>
						<option value="TJULIAN"/>
					</parameter>
				</option>
308
309
				<help>How is time represented: a filed combines date and time or these are split into two fields?</help>
			</parameter>
310
			<parameter key="CSV_FALLBACK_YEAR" type="number" format="integer+" notoggle="true">
311
312
313
314
315
316
317
				<help>When using components date (ie separate columns for year, month, day), it could be that there is no year column. This parameter provides the (fixed) year to use</help>
			</parameter>
			<parameter key="CSV_FALLBACK_AUTO_WRAP" type="alternative">
				<option value="TRUE"/>
				<option value="FALSE"/>
				<help>If using CSV_FALLBACK_YEAR, by default all data at dates greater than 1st October that appear before data at dates less than 1st October are assumed to belong to the year before. If this is not desired, set this to false.</help>
			</parameter>
318
		</frame>
319

320
321
		<frame caption="Metadata" color="#c4c4c4">
			<parameter key="CSV_NAME" type="text">
322
				<help>A descriptive station name to use (if provided, has priority over the special headers). Example: "Davos::SLF-station"</help>
323
324
			</parameter>
			<parameter key="CSV_ID" type="text">
325
				<help>The (short) station ID to use (if provided, has priority over the special headers). The station ID is often used to built the output file name as well as to apply specific processing at specific stations, if necessary. Example: "SLF2"</help>
326
			</parameter>
327
328
329
			<parameter key="CSV_SLOPE" type="number" format="integer+" min="0" max="90">
				<help>The slope angle at the station, in degrees (if providing a slope, also provide an azimuth)</help>
			</parameter>
330
			<parameter key="CSV_AZIMUTH" type="number" format="integer+" min="0" max="360">
331
332
				<help>The slope azimuth at the station, in degrees from North </help>
			</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
333
			<parameter key="POSITION" type="text" validate="coordinates">
334
				<help>Coordinates are given as lat/lon/alt or easting/northing/alt such as &lt;b&gt;"latlon (46.75, 9.80, 2200)"&lt;/b&gt; or &lt;b&gt;"xy (198754, 723458, 2200)"&lt;/b&gt;</help>
335
			</parameter>
336
337
338
339
340
341
342
			<parameter key="CSV_SPECIAL_HEADERS" type="text">
				<help>Description of how to extract more metadata out of the headers, such as &lt;code&gt;name:1:3 id:2:5 lat:3:2 lon:3:4 alt:3:6&lt;/code&gt;</help>
			</parameter>
			<parameter key="CSV_FILENAME_SPEC" type="text">
				<help>Pattern to parse the filename and extract metadata out of it, such as &lt;code&gt;{ID}_{NAME}-{SKIP}_-_{PARAM}&lt;/code&gt;</help>
			</parameter>
		</frame>
343
344
345

		<parameter key="STATION#" type="grid" replicate="true"> <!-- a grid without raster positions aligns vertically -->
			<option>
346
				<parameter key="STATION#" type="filename" mode="input" optional="false">
Mathias Bavay's avatar
Mathias Bavay committed
347
					<help>File name containing the data for station number #</help>
348
349
350
				</parameter>
			</option>
			<option>
Mathias Bavay's avatar
Mathias Bavay committed
351
				<parameter key="POSITION#" type="text" validate="coordinates">
352
					<help>Coordinates are given as lat/lon/alt or easting/northing/alt such as &lt;b&gt;"latlon (46.75, 9.80, 2200)"&lt;/b&gt; or &lt;b&gt;"xy (198754, 723458, 2200)"&lt;/b&gt;</help>
353
354
355
356
357
				</parameter>
			</option>
			<option>
				<reference name="CSV_NUMBERED_STATION"/>
			</option>
Mathias Bavay's avatar
Mathias Bavay committed
358
			<help>Enter file name and position for station number #</help>
359
360
361
362
		</parameter>
	</parametergroup>

	<parametergroup name="CSV_NUMBERED_STATION">
363
		<parameter type="alternative">
364
365
366
367
			<option value="Show station specific settings">
				<parameter key="CSV#_DELIMITER" type="text" default="," size="small">
					<help>Field delimiter character</help>
				</parameter>
368
				<parameter key="CSV#_NODATA" type="text">
369
370
					<help>A value that should be interpreted as &lt;code&gt;nodata&lt;/code&gt;</help>
				</parameter>
371
372
373
				<parameter key="CSV#_EXCLUDE_LINES" type="text" size="large" validate="^(?:\d+(?:\s\-\s\d+)?(?:\s?,\s)?)+$">
					<help>Exclude a comma delimited list of line ranges (line numbers separated by ' - ') such as &lt;i&gt;456 - 468&lt;/i&gt; or individual lines</help>
				</parameter>
374
375
376
				<parameter key="CSV#_COMMENTS_MK" type="text" validate="^.$">
					<help>Single character to use as marker for comments in the input file (default: none)</help>
				</parameter>
377
378
				<parameter key="CSV#_PURGE_CHARS" type="text" size="large" validate="^(?:\S|(\d{1,3})|(0[xX][0-9a-fA-F]{2}))(?:\s(\S|(\d{1,3})|(0[xX][0-9a-fA-F]{2})))*\s*$">
					<help>Exclude a space delimited list of characters, either directly provided or as decimal representation or as hexadecimal representation prefixed by &lt;i&gt;0x&lt;/i&gt;. Example: &lt;i&gt;0x40 " 13&lt;/i&gt;</help>
379
380
381
382
383
384
385
386
387
388
389
				</parameter>
				<frame caption="Header handling" color="#c4c4c4">
					<parameter key="CSV#_NR_HEADERS" type="number" format="integer+" min="0" default="1" notoggle="true">
						<help>Number of header lines</help>
					</parameter>
					<parameter key="CSV#_HEADER_DELIMITER" type="text" default="" size="small">
						<help>different field delimiter to use in header lines</help>
					</parameter>
					<parameter key="CSV#_HEADER_REPEAT_MK" type="text" size="large">
						<help>A string that is used to signal another copy of the headers mixed with the data in the file (the matching is done anywhere in the line)</help>
					</parameter>
390
					<parameter key="CSV#_UNITS_HEADERS" type="number" format="integer+" size="large" notoggle="true">
391
392
393
394
395
396
397
398
						<help>Header line providing the measurements units</help>
					</parameter>
					<parameter key="CSV#_UNITS_OFFSET" type="text" size="large">
						<help>Offset to add to each value in order to convert it to SI, such as &lt;code&gt;0 0 273.15&lt;/code&gt;</help>
					</parameter>
					<parameter key="CSV#_UNITS_MULTIPLIER" type="text" size="large">
						<help>Factor to multiply each value by, in order to convert it to SI, such as &lt;code&gt;1 1 0.01&lt;/code&gt;</help>
					</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
399
400
401
					<parameter key="CSV#_UNITS" type="text" size="large">
						<help>Space delimited list of units to use for the columns (including the timestamp). No units is represented by "-". This can not be used together with units_offset / units multiplier</help>
					</parameter>
402
403
				</frame>
				<frame caption="Fields parsing" color="#c4c4c4">
404
					<parameter key="CSV#_COLUMNS_HEADERS" type="number" format="integer+" notoggle="true">
405
406
407
						<help>header line number to interpret as columns headers</help>
					</parameter>
					<parameter key="CSV#_FIELDS" type="text" size="large">
408
						<help>Provide a column header (if none is present or to overwrite it) such as &lt;code&gt;DATE TIME ID TA&lt;/code&gt;. See in the &lt;a href="https://models.slf.ch/docserver/dev/meteoio/doc/html/csvio.html#csvio_metadata_field_types"&gt;documentation&lt;/a&gt; for details.</help>
409
410
411
					</parameter>
					<parameter key="CSV#_FILTER_ID" type="text" size="large">
						<help>if the data contains an "ID" column, which ID should be kept (all others will be rejected); default: station ID</help>
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
					</parameter>
					<parameter key="CSV#_SKIP_FIELDS" type="text" size="large">
						<help>A space-delimited list of field to skip (first field is numbered 1). Keep in mind that when using parameters such as &lt;code&gt;UNITS_OFFSET&lt;/code&gt;, the skipped field MUST be taken into consideration (since even if a field is skipped, it is still present in the file!)</help>
					</parameter>
				</frame>
				<frame caption="Date/Time handling" color="#c4c4c4">
					<parameter key="CSV#_TIMESTAMP" type="alternative">
						<option value="COMBINED">
							<parameter key="CSV#_DATETIME_SPEC" type="text">
								<help>Mixed date and time format specification, such as &lt;code&gt;YYYY-MM-DDTHH24:MI:SS&lt;/code&gt;</help>
							</parameter>
						</option>
						<option value="SPLIT">
							<parameter key="CSV#_DATE_SPEC" type="text">
								<help>Date format specification, such as &lt;code&gt;YYYY-MM-DD&lt;/code&gt;</help>
							</parameter>
							<parameter key="CSV#_TIME_SPEC" type="text">
								<help>Time format specification, such as &lt;code&gt;HH24:MI:SS&lt;/code&gt;</help>
							</parameter>
						</option>
						<help>How is time represented: a filed combines date and time or these are split into two fields?</help>
					</parameter>
434
					<parameter key="CSV#_FALLBACK_YEAR" type="number" format="integer+" notoggle="true">
435
436
437
438
439
440
441
						<help>When using components date (ie separate columns for year, month, day), it could be that there is no year column. This parameter provides the (fixed) year to use</help>
					</parameter>
					<parameter key="CSV#_FALLBACK_AUTO_WRAP" type="alternative">
						<option value="TRUE"/>
						<option value="FALSE"/>
						<help>If using CSV_FALLBACK_YEAR, by default all data at dates greater than 1st October that appear before data at dates less than 1st October are assumed to belong to the year before. If this is not desired, set this to false.</help>
					</parameter>
442
443
444
				</frame>
				<frame caption="Metadata" color="#c4c4c4">
					<parameter key="CSV#_NAME" type="text">
445
						<help>A descriptive station name to use (if provided, has priority over the special headers). Example: "Davos::SLF-station"</help>
446
447
					</parameter>
					<parameter key="CSV#_ID" type="text">
448
						<help>The (short) station ID to use (if provided, has priority over the special headers). The station ID is often used to built the output file name as well as to apply specific processing at specific stations, if necessary. Example: "SLF2"</help>
449
					</parameter>
450
451
452
					<parameter key="CSV#_SLOPE" type="number" format="integer+" min="0" max="90">
						<help>The slope angle at the station, in degrees (if providing a slope, also provide an azimuth)</help>
					</parameter>
453
					<parameter key="CSV#_AZIMUTH" type="number" format="integer+" min="0" max="360">
454
455
						<help>The slope azimuth at the station, in degrees from North </help>
					</parameter>
456
457
458
459
460
461
462
463
464
465
466
					<parameter key="CSV#_SPECIAL_HEADERS" type="text">
						<help>Description of how to extract more metadata out of the headers, such as &lt;code&gt;name:1:3 id:2:5 lat:3:2 lon:3:4 alt:3:6&lt;/code&gt;</help>
					</parameter>
					<parameter key="CSV#_FILENAME_SPEC" type="text">
						<help>Pattern to parse the filename and extract metadata out of it, such as &lt;code&gt;{ID}_{NAME}-{SKIP}_-_{PARAM}&lt;/code&gt;</help>
					</parameter>
				</frame>
			</option>
			<option value="Hide station specific settings" default="true"/>
			<help>If you have given station numbers you can set most of the keys from above individually for each station. If not set, the global value will be used.</help>
		</parameter>
467
	</parametergroup>
468

469
470
471
472
473
474
475
476
477
	<!-- DBO -->
	<parametergroup name="DBO_IN">
		<parameter key="DBO_URL" type="text" optional="false">
			<help>RESTful service URL (e.g.http://developwis.wsl.ch:8730)</help>
		</parameter>
		<reference name="STATIONGROUP_NAMES"/>
		<parameter key="DBO_TIMEOUT" type="number" format="integer+" default="60" optional="false">
			<help>timeout (in seconds) for the connection to the server</help>
		</parameter>
478
		<parameter key="DBO_DEBUG" type="alternative">
479
480
481
482
483
484
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>print the full requests/answers from the server when something does not work as expected</help>
		</parameter>
	</parametergroup>

485
486
487
	<!-- GEOTOP -->
	<parametergroup name="GEOTOP_IN">
		<parameter key="METEOPATH" type="path" optional="false">
488
			<help>Path to the data files</help>
489
490
491
492
		</parameter>
		<parameter key="METEOPREFIX" type="text">
			<help>prefix to append when generating a file name for reading</help>
		</parameter>
493
		<parameter key="METAFILE" type="file" mode="input" optional="false">
494
495
496
			<help>Absolute filename of the geotop.inpts file</help>
		</parameter>
	</parametergroup>
497

498
499
500
501
502
503
504
505
	<!-- GOES -->
	<parametergroup name="GOES_IN">
		<parameter key="METEOPATH" type="path" optional="false">
			<help>directory where to read the data files from</help>
		</parameter>
		<parameter key="GOES_EXT" type="text" size="small">
			<help>extension of Goes data files to use when no FILE# keyword has been provided</help>
		</parameter>
506
		<parameter key="METEOPATH_RECURSIVE" type="alternative">
507
508
509
510
511
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>when no METEOFILE# keyword has been defined, should all files under METEOPATH be searched recursively?</help>
		</parameter>
		<reference name="FILESGROUP"/>
512
		<parameter key="METAFILE" type="file" mode="input" optional="false">
513
514
			<help>an ini file that contains all the metadata, for each station that has to be read</help>
		</parameter>
515
		<parameter key="GOES_NODATA" type="number" format="integer" default="-8190" optional="false" notoggle="true">
516
517
			<help>value used to represent nodata</help>
		</parameter>
518
519
520
521
522
		<parameter key="GOES_ONLYFROMPAST" type="alternative" default="TRUE">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>if set to true, data point beyond the current date and time will be rejected as invalid</help>
		</parameter>
523
		<parameter key="GOES_DEBUG" type="alternative">
524
525
526
527
528
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>should extra (ie very verbose) information be displayed?</help>
		</parameter>
	</parametergroup>
529
530

	<!-- GRIB -->
531
	<parametergroup name="GRIB_METEO_IN">
532
		<parameter key="METEOPATH" type="path" optional="false">
533
			<help>Path to the grib files</help>
534
535
536
537
538
		</parameter>
		<parameter key="METEOEXT" type="text">
			<help>GRIB file extension, or none for no file extension (default: .grb)</help>
		</parameter>
		<reference name="STATIONGROUP_POSITION"/>
539
		<parameter key="GRIB_DEBUG" type="alternative">
540
541
542
543
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>output more information about the grib files in order to help fix potential problems</help>
		</parameter>
544
545
546
	</parametergroup>

	<!-- IMIS -->
547
	<parametergroup name="IMIS_IN">
548
		<parameter key="DBNAME" type="text" optional="false">
549
			<help>Database name, either as //hostname:port/service_name (exemple: //sdbo.wd.op:1521/sdbo.slf.ch) or as a symbolic name as defined in the tnsnames.ora Network Configuration File provided by the Database administrator.</help>
550
551
552
553
554
555
556
		</parameter>
		<parameter key="DBUSER" type="text" optional="false">
			<help>Database user name</help>
		</parameter>
		<parameter key="DBPASS" type="text" optional="false">
			<help>Database password associated with the user name</help>
		</parameter>
557
		<reference name="STATIONGROUP_NAMES"/>
558
		<parameter key="USEANETZ" type="alternative">
559
560
561
562
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>OPTIONAL: use ANETZ stations to provide precipitations for normal IMIS stations.
				Each IMIS station is associated with one or two ANETZ stations and does a weighted
563
				average to get what should be its local precipitations (default: false)</help>
564
		</parameter>
565
		<parameter key="USE_IMIS_PSUM" type="alternative">
566
567
			<option value="TRUE"/>
			<option value="FALSE"/>
568
			<help>OPTIONAL: if set to false (default), all IMIS precipitation will be deleted (since IMIS stations don't have heated rain gauges, their precipitation measurements are not good in winter conditions). If set to true, it is strongly advised to use a UNHEATED_RAINGAUGE filter to detect snow melting in the rain gauge and perform winter conditions detection in the application (default: false).</help>
569
		</parameter>
570
		<parameter key="USE_SNOWPACK_PSUM" type="alternative">
571
572
573
574
575
576
577
578
579
580
581
582
583
584
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>if set to true, the SNOWPACK simulated Snow Water Equivalent from the database will be used to compute PSUM. Data gaps greater than 3 hours on SWE will lead to unchanged hnw while all data that can properly be computed will overwrite hnw. (default=false)</help>
		</parameter>
	</parametergroup>

	<!-- NETCDF -->
	<parametergroup name="NETCDF_IN">
		<parameter key="METEOPATH" type="path" optional="false">
			<help>Path to the data files</help>
		</parameter>
		<parameter key="NC_EXT" type="text" default=".nc" size="small">
			<help>NetCDF file extension (for example: .nc)</help>
		</parameter>
585
		<reference name="FILESGROUP_OPTIONAL"/>
586
		<parameter key="METEOPATH_RECURSIVE" type="alternative">
587
588
			<option value="TRUE"/>
			<option value="FALSE"/>
589
			<help>when no METEOFILE# keyword has been defined, should all files under METEOPATH be searched recursively? (default: false)</help>
590
		</parameter>
591
592
593
594
		<parameter key="NETCDF_SCHEMA" type="alternative" default="CF-1.6">
			<option value="CF-1.6"/>
			<option value="CROCUS"/>
			<option value="AMUNDSEN"/>
595
596
			<option value="ERA-INTERIM"/>
			<option value="ERA5"/>
597
598
599
			<option value="WRF"/>
			<help>Data schema to use (i. e. mostly variables and dimensions naming)</help>
		</parameter>
600
		<parameter label="Remap variables:" type="selector">
601
			<parameter key="NETCDF_VAR::%" type="text" template="true">
602
603
604
				<help>parameter name as found in the current NetCDF file</help>
			</parameter>
			<reference name="METEOGRIDS"/>
605
			<help>remap the names as found in the NetCDF file to MeteoIO's &lt;a href=https://models.slf.ch/docserver/meteoio/html/classmio_1_1MeteoGrids.html#a2063b187182804ab133b154b65ae592c"&gt;MeteoGrids::parameters&lt;/a&gt;</help>
606
607
		</parameter>
		<parameter label="Remap dimensions:" type="selector">
608
			<parameter key="NETCDF_DIM::%" type="text" template="true">
609
610
611
				<help>dimension name as found in the current NetCDF file</help>
			</parameter>
			<reference name="METEOGRIDS"/>
612
			<help>remap the names as found in the NetCDF file to MeteoIO's &lt;a href=https://models.slf.ch/docserver/meteoio/html/classmio_1_1MeteoGrids.html#a2063b187182804ab133b154b65ae592c"&gt;MeteoGrids::parameters&lt;/a&gt;</help>
613
		</parameter>
614
615
616
617
618
		<parameter key="NC_KEEP_FILES_OPEN" type="alternative">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>keep files open for efficient access? Beware, there is a max number of simultaneously opened files (default: true)</help>
		</parameter>
619
		<parameter key="NC_DEBUG" type="alternative">
620
621
622
623
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>print some low level details about the file being read</help>
		</parameter>
624
625
626
	</parametergroup>

	<!-- OSHD -->
627
	<parametergroup name="OSHD_METEO_IN">
628
629
630
		<parameter key="METEOPATH" type="path" optional="false">
			<help>Path to the data files</help>
		</parameter>
631
		<parameter key="METEOPATH_RECURSIVE" type="alternative">
632
633
			<option value="TRUE"/>
			<option value="FALSE"/>
634
			<help>If set to true, files are recursively searched within &lt;a href=&quot;app://input::meteopath&quot;&gt;METEOPATH&lt;/a&gt; (default: false)</help>
635
		</parameter>
636
		<reference name="STATIONGROUP_NAMES"/>
637
		<parameter key="METAFILE" type="file" mode="input" optional="false">
638
639
			<help>Absolute filename of the metadata file</help>
		</parameter>
640
		<parameter key="OSHD_DEBUG" type="alternative">
641
642
643
644
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>write out extra information to better show what is in the files</help>
		</parameter>
645
646
647
648
649
650
651
	</parametergroup>

	<!-- PSQL -->
	<parametergroup name="PSQL_IN">
		<parameter key="PSQL_URL" type="text" optional="false">
			<help>Database URL</help>
		</parameter>
652
		<parameter key="PSQL_PORT" type="text" validate="[0-9]+" size="small">
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
			<help>Database port to use for connection</help>
		</parameter>
		<parameter key="PSQL_DB" type="text" optional="false">
			<help>Database name</help>
		</parameter>
		<parameter key="PSQL_USER" type="text" optional="false"/>
		<parameter key="PSQL_PASS" type="text" optional="false"/>
		<parameter key="SQL_META" type="text" optional="false">
			<help>Query to retrieve the metadata. For example, &lt;code&gt;SELECT id, station_name AS name, x_coord AS x, y_coord AS y, z AS altitude, epsg from all_stations WHERE id IN&lt;/code&gt;
			</help>
		</parameter>
		<parameter key="SQL_DATA" type="text" optional="false">
			<help>Query to retrieve the data. For example, &lt;code&gt;SELECT * FROM all_measurements WHERE id = ''STATIONID'' AND date&gt;=''DATE_START'' AND date&lt;=''DATE_END'' ORDER BY date&lt;/code&gt;
			</help>
		</parameter>
		<parameter key="STATIONS" type="text" optional="false">
			<help>Comma-separated list of station IDs to use</help>
		</parameter>
	</parametergroup>

	<!-- SASE -->
674
	<parametergroup name="SASE_IN">
675
676
677
678
679
680
681
682
683
684
685
686
687
688
		<parameter key="SASE_HOST" type="text" optional="false">
			<help>Database host name, as provided by your database administrator</help>
		</parameter>
		<parameter key="SASE_DB" type="text" optional="false">
			<help>Database name, as provided by your database administrator</help>
		</parameter>
		<parameter key="SASE_USER" type="text" optional="false">
			<help>Database user name</help>
		</parameter>
		<parameter key="SASE_PASS" type="string" optional="false">
			<help>Database password associated with the user name</help>
		</parameter>
		<reference name="STATIONGROUP_NAMES"/>
	</parametergroup>
689

690
691
692
693
694
	<!-- SMET -->
	<parametergroup name="SMET_IN">
		<parameter key="METEOPATH" type="path" optional="false">
			<help>Directory of your SMET data files</help>
		</parameter>
695
		<parameter key="METEOPATH_RECURSIVE" type="alternative">
696
697
			<option value="TRUE"/>
			<option value="FALSE"/>
698
			<help>If set to true, files are recursively searched within &lt;a href=&quot;app://input::meteopath&quot;&gt;METEOPATH&lt;/a&gt; (default: false)</help>
699
700
		</parameter>
		<reference name="STATIONGROUP_FILES_OPTIONAL"/>
701
		<parameter key="SNOWPACK_SLOPES" type="alternative">
702
703
			<option value="TRUE"/>
			<option value="FALSE"/>
704
			<help>if set to true and no slope information is found in the input files, the IMIS/Snowpack naming scheme will be used to derive the slope information (default: false)</help>
705
706
		</parameter>
	</parametergroup>
707
708
709
710

	<!-- SNOWPACK -->
	<parametergroup name="SNOWPACK_IN">
		<parameter key="METEOPATH" type="path" optional="false">
711
			<help>Path to the SNOWPACK files</help>
712
		</parameter>
713
		<reference name="STATIONGROUP_FILES"/>
714
		<parameter key="METAFILE" type="filename" mode="input" optional="false">
715
716
			<help>filename of the meta data file (in METEOPATH)</help>
		</parameter>
717
		<parameter key="NUMBER_MEAS_TEMPERATURES" type="number" format="integer" min="0" default="0" optional="false" notoggle="true">
718
719
			<help>Number of measured snow temperatures that are provided</help>
		</parameter>
720
		<parameter key="NUMBER_OF_SOLUTES" type="number" format="integer+" default="0" optional="false" notoggle="true">
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
			<help>Number of solutes for which input data are provided</help>
		</parameter>
		<parameter key="RSWR_INP" type="alternative" optional="FALSE">
			<option value="TRUE"/>
			<option value="FALSE"/>
		</parameter>
		<parameter key="ISWR_INP" type="alternative" optional="FALSE">
			<option value="TRUE"/>
			<option value="FALSE"/>
		</parameter>
		<parameter key="VW_DRIFT" type="alternative" default="FALSE">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>OPTIONAL: wind velocity to use for blowing and drifting snow is provided</help>
		</parameter>
		<parameter key="RHO_HN" type="alternative" default="FALSE">
			<option value="TRUE"/>
			<option value="FALSE"/>
			<help>OPTIONAL: measured new snow density is provided</help>
		</parameter>
	</parametergroup>

</inishell_include>