comparison: docs/file_formats/elda_product_format.rst
docs/file_formats/elda_product_format.rst
- changeset 125
- 003aa42747f5
equal
deleted
inserted
replaced
| 124:becb9de86607 | 125:003aa42747f5 |
|---|---|
| 1 ELDA Products | |
| 2 ---------------- | |
| 3 | |
| 4 This section describe the structure of ELDA products. | |
| 5 | |
| 6 | |
| 7 ELPP Products: dimensions | |
| 8 ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 9 | |
| 10 Aerosol optical products have the wavelength dimension (accommodating products at different wavelength in the same variable) and time dimension (accommodating different profiles in the same time series). The altitude dimension is defined for reporting the information as a function of the altitude. The dimension nv is used following the cf convention whenever a bound is needed for some evaluation. In our case nv is used for defining variables which have per definition some bounds as time_bounds reported below. | |
| 11 | |
| 12 The following dimensions are defined in ELDA products: | |
| 13 | |
| 14 - time | |
| 15 - altitude | |
| 16 - wavelength | |
| 17 - nv | |
| 18 | |
| 19 The dimension *time* (mandatory) specifies the number of vertical profiles included in the product timeseries. | |
| 20 | |
| 21 The dimension *altitude* (mandatory) represents the number of rangebins characterizing each vertical profile | |
| 22 | |
| 23 The dimension *wavelength* (mandatory) indicates the number wavelengths for which the optical variables are provided | |
| 24 | |
| 25 The dimension *nv* (mandatory) is ancillary and it is always set to 2. | |
| 26 | |
| 27 | |
| 28 | |
| 29 ELDA Products: variables | |
| 30 ~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 31 | |
| 32 latitude | |
| 33 :Type: *float* | |
| 34 :Dimensions: -- | |
| 35 :Variable\_Type: Mandatory | |
| 36 :Description: measurement site latitude | |
| 37 :Units: degrees_north | |
| 38 :Definition: *float latitude* | |
| 39 | |
| 40 longitude | |
| 41 :Type: *float* | |
| 42 :Dimensions: -- | |
| 43 :Variable\_Type: Mandatory | |
| 44 :Description: measurement site longitude | |
| 45 :Units: degrees_east | |
| 46 :Definition: *float longitude* | |
| 47 | |
| 48 station\_altitude | |
| 49 :Type: *float* | |
| 50 :Dimensions: -- | |
| 51 :Variable\_Type: Mandatory | |
| 52 :Description: station altitude above see level | |
| 53 :Units: m | |
| 54 :Definition: *float station\_altitude* | |
| 55 | |
| 56 altitude | |
| 57 :Type: *double* | |
| 58 :Dimensions: *altitude* | |
| 59 :Variable\_Type: Mandatory | |
| 60 :Description: altitude above see level | |
| 61 :Units: m | |
| 62 :Definition: *double altitude(altitude)* | |
| 63 | |
| 64 time | |
| 65 :Type: *double* | |
| 66 :Dimensions: *time* | |
| 67 :Variable\_Type: Mandatory | |
| 68 :Description: seconds since 1970-01-01T00:00:00Z | |
| 69 :Units: -- | |
| 70 :Definition: *double time(time)* | |
| 71 | |
| 72 time\_bounds | |
| 73 :Type: *double* | |
| 74 :Dimensions: *time, nv* | |
| 75 :Variable\_Type: Mandatory | |
| 76 :Description: seconds since 1970-01-01T00:00:00Z | |
| 77 :Units: -- | |
| 78 :Definition: *double time\_bounds(time,nv)* | |
| 79 | |
| 80 shots | |
| 81 :Type: *int* | |
| 82 :Dimensions: *time* | |
| 83 :Variable\_Type: Mandatory | |
| 84 :Description: accumulated laser shots | |
| 85 :Units: -- | |
| 86 :Definition: *int shots(time)* | |
| 87 | |
| 88 cloud\_mask\_type | |
| 89 :Type: *byte* | |
| 90 :Dimensions: -- | |
| 91 :Variable\_Type: Mandatory | |
| 92 :Description: Bimask describing the cloudmask type | |
| 93 :Units: -- | |
| 94 :Definition: *byte cloud_mask_type* | |
| 95 | |
| 96 cloud\_mask | |
| 97 :Type: *byte* | |
| 98 :Dimensions: *time, altitude* | |
| 99 :Variable\_Type: Optional | |
| 100 :Description: Bimask describing the cloudmask | |
| 101 :Units: -- | |
| 102 :Definition: *byte cloud_mask(time, altitude)* | |
| 103 | |
| 104 vertical\_resolution | |
| 105 :Type: *double* | |
| 106 :Dimensions: *wavelength, time, altitude* | |
| 107 :Variable\_Type: Mandatory | |
| 108 :Description: Effective vertical resolution according to Pappalardo et al., appl. opt. 2004 | |
| 109 :Units: *m* | |
| 110 :Definition: *double vertical\_resolution(wavelength, time, altitude)* | |
| 111 | |
| 112 | |
| 113 cirrus\_contamination | |
| 114 :Type: *byte* | |
| 115 :Dimensions: -- | |
| 116 :Variable\_Type: Mandatory | |
| 117 :Description: Do the profiles contain cirrus layers? | |
| 118 :Units: -- | |
| 119 :Definition: *byte cirrus\_contamination* | |
| 120 | |
| 121 cirrus\_contamination\_source | |
| 122 :Type: *byte* | |
| 123 :Dimensions: -- | |
| 124 :Variable\_Type: Mandatory | |
| 125 :Description: How was cirrus_contamination obtained? | |
| 126 :Units: -- | |
| 127 :Definition: *byte cirrus\_contamination\_source* | |
| 128 | |
| 129 | |
| 130 error\_retrieval\_method | |
| 131 :Type: *byte* | |
| 132 :Dimensions: *wavelength* | |
| 133 :Variable\_Type: Mandatory | |
| 134 :Description: Method used for the retrieval of erros (uncertainties) | |
| 135 :Units: -- | |
| 136 :Definition: *byte error\_retrieval\_method(wavelength)* | |
| 137 | |
| 138 | |
| 139 backscatter\_evaluation\_method | |
| 140 :Type: *byte* | |
| 141 :Dimensions: *wavelength* | |
| 142 :Variable\_Type: Optional | |
| 143 :Description: Method used for the backscatter retrieval | |
| 144 :Units: -- | |
| 145 :Definition: *byte backscatter\_evaluation\_method(wavelength)* | |
| 146 | |
| 147 elastic\_backscatter\_algorithm | |
| 148 :Type: *byte* | |
| 149 :Dimensions: *wavelength* | |
| 150 :Variable\_Type: Optional | |
| 151 :Description: Algorithm used for the retrieval of the elastic backscatter profile | |
| 152 :Units: -- | |
| 153 :Definition: *byte elastic\_backscatter\_algorithm(wavelength)* | |
| 154 | |
| 155 | |
| 156 | |
| 157 assumed\_particle\_lidar\_ratio | |
| 158 :Type: *double* | |
| 159 :Dimensions: *wavelength, time, altitude* | |
| 160 :Variable\_Type: Optional | |
| 161 :Description: Assumed particle lidar ratio for the elastic-only backscatter retrieval | |
| 162 :Units: *sr* | |
| 163 :Definition: *double assumed\_particle\_lidar\_ratio(wavelength, time, altitude)* | |
| 164 | |
| 165 | |
| 166 backscatter | |
| 167 :Type: *double* | |
| 168 :Dimensions: *wavelength, time, altitude* | |
| 169 :Variable\_Type: Optional | |
| 170 :Description: Particle backscatter coefficient | |
| 171 :Units: *1/(m\*sr)* | |
| 172 :Definition: *double backscatter(wavelength, time, altitude)* | |
| 173 | |
| 174 error\_backscatter | |
| 175 :Type: *double* | |
| 176 :Dimensions: *wavelength, time, altitude* | |
| 177 :Variable\_Type: Optional | |
| 178 :Description: Absolute statistical error (unertanity) of particle backscatter coefficient | |
| 179 :Units: *1/(m\*sr)* | |
| 180 :Definition: *double error\_backscatter(wavelength, time, altitude)* | |
| 181 | |
| 182 extinction | |
| 183 :Type: *double* | |
| 184 :Dimensions: *wavelength, time, altitude* | |
| 185 :Variable\_Type: Optional | |
| 186 :Description: Particle extinction coefficient | |
| 187 :Units: *1/m* | |
| 188 :Definition: *double extinction(wavelength, time, altitude)* | |
| 189 | |
| 190 error\_extinction | |
| 191 :Type: *double* | |
| 192 :Dimensions: *wavelength, time, altitude* | |
| 193 :Variable\_Type: Optional | |
| 194 :Description: Absolute statistical error (unertanity) of particle extinction coefficient | |
| 195 :Units: *1/m* | |
| 196 :Definition: *double error\_extinction(wavelength, time, altitude)* | |
| 197 | |
| 198 volumedepolarization | |
| 199 :Type: *double* | |
| 200 :Dimensions: *wavelength, time, altitude* | |
| 201 :Variable\_Type: Optional | |
| 202 :Description: Volume linear depolarization ratio | |
| 203 :Units: -- | |
| 204 :Definition: *double volumedepolarization(wavelength, time, altitude)* | |
| 205 | |
| 206 error\_volumedepolarization | |
| 207 :Type: *double* | |
| 208 :Dimensions: *wavelength, time, altitude* | |
| 209 :Variable\_Type: Optional | |
| 210 :Description: Absolute statistical error (unertanity) of volume linear depolarization ratio | |
| 211 :Units: *1/m* | |
| 212 :Definition: *double error\_volumedepolarization(wavelength, time, altitude)* | |
| 213 | |
| 214 particledepolarization | |
| 215 :Type: *double* | |
| 216 :Dimensions: *wavelength, time, altitude* | |
| 217 :Variable\_Type: Optional | |
| 218 :Description: Particle linear depolarization ratio | |
| 219 :Units: -- | |
| 220 :Definition: *double particledepolarization(wavelength, time, altitude)* | |
| 221 | |
| 222 error\_particledepolarization | |
| 223 :Type: *double* | |
| 224 :Dimensions: *wavelength, time, altitude* | |
| 225 :Variable\_Type: Optional | |
| 226 :Description: Absolute statistical error (unertanity) of particle linear depolarization ratio | |
| 227 :Units: *1/m* | |
| 228 :Definition: *double error\_particledepolarization(wavelength, time, altitude)* | |
| 229 | |
| 230 | |
| 231 user\_defined\_category | |
| 232 :Type: *int* | |
| 233 :Dimensions: -- | |
| 234 :Variable\_Type: Optional | |
| 235 :Description: User defined category of the measurement | |
| 236 :Units: -- | |
| 237 :Definition: *int user\_defined_category* | |
| 238 | |
| 239 | |
| 240 molecular\_calculation\_source | |
| 241 :Type: *byte* | |
| 242 :Dimensions: -- | |
| 243 :Variable\_Type: Mandatory | |
| 244 :Description: Data source of the molecular calculations | |
| 245 :Units: -- | |
| 246 :Definition: *byte molecular\_calculation\_source* | |
| 247 | |
| 248 | |
| 249 backscatter\_calibration\_value | |
| 250 :Type: *float* | |
| 251 :Dimensions: *wavelength* | |
| 252 :Variable\_Type: Optional | |
| 253 :Description: Assumed backscatter-ratio value (unitless) in calibration range | |
| 254 :Units: -- | |
| 255 :Definition: *float backscatter\_calibration\_value(wavelength)* | |
| 256 | |
| 257 backscatter\_calibration\_search\_range | |
| 258 :Type: *float* | |
| 259 :Dimensions: *wavelength, nv* | |
| 260 :Variable\_Type: Optional | |
| 261 :Description: Height range wherein calibration range is searched | |
| 262 :Units: *m* | |
| 263 :Definition: *float backscatter\_calibration\_search\_range(wavelength, nv)* | |
| 264 | |
| 265 wavelength | |
| 266 :Type: *float* | |
| 267 :Dimensions: *wavelength* | |
| 268 :Variable\_Type: Mandatory | |
| 269 :Description: Wavelength of the transmitted laser pulse | |
| 270 :Units: *nm* | |
| 271 :Definition: *float wavelength(wavelength)* | |
| 272 | |
| 273 zenith\_angle | |
| 274 :Type: *float* | |
| 275 :Dimensions: -- | |
| 276 :Variable\_Type: Mandatory | |
| 277 :Description: Laser pointing angle with respect to the zenith | |
| 278 :Units: *degrees* | |
| 279 :Definition: *float zenith\_angle* | |
| 280 | |
| 281 | |
| 282 earlinet_product_type | |
| 283 :Type: *int* | |
| 284 :Dimensions: -- | |
| 285 :Variable\_Type: Mandatory | |
| 286 :Description: Earlinet product type | |
| 287 :Units: -- | |
| 288 :Definition: *int earlinet_product_type* | |
| 289 | |
| 290 backscatter\_calibration\_range_search\_algorithm | |
| 291 :Type: *byte* | |
| 292 :Dimensions: *wavelength* | |
| 293 :Variable\_Type: Optional | |
| 294 :Description: Algorithm used for the search of the calibration_range | |
| 295 :Units: -- | |
| 296 :Definition: *byte backscatter\_calibration\_range\_search\_algorithm(wavelength)* | |
| 297 | |
| 298 | |
| 299 | |
| 300 backscatter\_calibration\_range | |
| 301 :Type: *float* | |
| 302 :Dimensions: *wavelength, nv* | |
| 303 :Variable\_Type: Optional | |
| 304 :Description: Height range where calibration was calculated | |
| 305 :Units: *m* | |
| 306 :Definition: *float backscatter\_calibration\_range(wavelength, nv)* | |
| 307 | |
| 308 raman\_backscatter\_algorithm | |
| 309 :Type: *byte* | |
| 310 :Dimensions: *wavelength* | |
| 311 :Variable\_Type: Optional | |
| 312 :Description: Algorithm used for the retrieval of the Raman backscatter profile | |
| 313 :Units: -- | |
| 314 :Definition: *byte raman\_backscatter\_algorithm(wavelength)* | |
| 315 | |
| 316 extinction\_evaluation\_algorithm | |
| 317 :Type: *byte* | |
| 318 :Dimensions: *wavelength* | |
| 319 :Variable\_Type: Optional | |
| 320 :Description: Algorithm used for the extinction retrieval | |
| 321 :Units: -- | |
| 322 :Definition: *byte extinction\_evaluation\_algorithm(wavelength)* | |
| 323 | |
| 324 extinction\_assumed\_wavelength\_dependence | |
| 325 :Type: *float* | |
| 326 :Dimensions: *wavelength* | |
| 327 :Variable\_Type: Optional | |
| 328 :Description: Assumed wavelength dependence for particle extinction retrieval | |
| 329 :Definition: *float extinction\_assumed\_wavelength\_dependence(wavelength)* | |
| 330 | |
| 331 scc\_product\_type | |
| 332 :Type: *byte* | |
| 333 :Dimensions: -- | |
| 334 :Variable\_Type: Mandatory | |
| 335 :Description: Bitmask describing the SCC product type | |
| 336 :Units: -- | |
| 337 :Definition: *byte scc\_product\_type* | |
| 338 | |
| 339 | |
| 340 | |
| 341 ELDA Products: global attributes | |
| 342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 343 | |
| 344 Conventions | |
| 345 :Type: *string* | |
| 346 :Global\_Attribute\_Type: Mandatory | |
| 347 :Description: List of the conventions the product is compliant to | |
| 348 | |
| 349 | |
| 350 title | |
| 351 :Type: *string* | |
| 352 :Global\_Attribute\_Type: Mandatory | |
| 353 :Description: Product title | |
| 354 | |
| 355 source | |
| 356 :Type: *string* | |
| 357 :Global\_Attribute\_Type: Mandatory | |
| 358 :Description: String describing the source used to generate the product | |
| 359 | |
| 360 references | |
| 361 :Type: *string* | |
| 362 :Global\_Attribute\_Type: Mandatory | |
| 363 :Description: Reference(s) for data processing | |
| 364 location | |
| 365 :Type: *string* | |
| 366 :Global\_Attribute\_Type: Mandatory | |
| 367 :Description: Measurement site location | |
| 368 | |
| 369 station_ID | |
| 370 :Type: *string* | |
| 371 :Global\_Attribute\_Type: Mandatory | |
| 372 :Description: Unique 3 digit code identifying SCC station | |
| 373 | |
| 374 PI | |
| 375 :Type: *string* | |
| 376 :Global\_Attribute\_Type: Mandatory | |
| 377 :Description: PI full name | |
| 378 | |
| 379 PI\_affiliation | |
| 380 :Type: *string* | |
| 381 :Global\_Attribute\_Type: Mandatory | |
| 382 :Description: PI complete affiliation | |
| 383 | |
| 384 PI\_affiliation_acronym | |
| 385 :Type: *string* | |
| 386 :Global\_Attribute\_Type: Mandatory | |
| 387 :Description: PI affiliation acronym | |
| 388 | |
| 389 PI\_address | |
| 390 :Type: *string* | |
| 391 :Global\_Attribute\_Type: Optional | |
| 392 :Description: PI address | |
| 393 | |
| 394 PI\_phone | |
| 395 :Type: *string* | |
| 396 :Global\_Attribute\_Type: Optional | |
| 397 :Description: PI phone number | |
| 398 | |
| 399 PI\_email | |
| 400 :Type: *string* | |
| 401 :Global\_Attribute\_Type: Mandatory | |
| 402 :Description: PI e-mail | |
| 403 | |
| 404 Data\_Originator | |
| 405 :Type: *string* | |
| 406 :Global\_Attribute\_Type: Mandatory | |
| 407 :Description: Data originator full name | |
| 408 | |
| 409 Data\_Originator\_affiliation | |
| 410 :Type: *string* | |
| 411 :Global\_Attribute\_Type: Mandatory | |
| 412 :Description: Data originator complete affiliation | |
| 413 | |
| 414 Data\_Originator\_affiliation\_acronym | |
| 415 :Type: *string* | |
| 416 :Global\_Attribute\_Type: Mandatory | |
| 417 :Description: Data originator affiliation acronym | |
| 418 | |
| 419 Data\_Originator\_address | |
| 420 :Type: *string* | |
| 421 :Global\_Attribute\_Type: Optional | |
| 422 :Description: Data originator complete address | |
| 423 | |
| 424 Data\_Originator\_phone | |
| 425 :Type: *string* | |
| 426 :Global\_Attribute\_Type: Optional | |
| 427 :Description: Data originator phone number | |
| 428 | |
| 429 Data\_Originator\_email | |
| 430 :Type: *string* | |
| 431 :Global\_Attribute\_Type: Mandatory | |
| 432 :Description: Data originator e-mail address | |
| 433 | |
| 434 institution | |
| 435 :Type: *string* | |
| 436 :Global\_Attribute\_Type: Mandatory | |
| 437 :Description: Istitution the product belong to | |
| 438 | |
| 439 system | |
| 440 :Type: *string* | |
| 441 :Global\_Attribute\_Type: Mandatory | |
| 442 :Description: Name of the measuring instrument (lidar) | |
| 443 | |
| 444 hoi\_system\_ID | |
| 445 :Type: *int* | |
| 446 :Global\_Attribute\_Type: Mandatory | |
| 447 :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) | |
| 448 | |
| 449 hoi\_configuration\_ID; | |
| 450 :Type: *int* | |
| 451 :Global\_Attribute\_Type: Mandatory | |
| 452 :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) | |
| 453 | |
| 454 measurement\_ID; | |
| 455 :Type: *string* | |
| 456 :Global\_Attribute\_Type: Mandatory | |
| 457 :Description: Alphanumeric identifier for the raw data measurements use to generate the product | |
| 458 | |
| 459 measurement\_start\_datetime | |
| 460 :Type: *string* | |
| 461 :Global\_Attribute\_Type: Mandatory | |
| 462 :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ | |
| 463 | |
| 464 measurement\_stop\_datetime | |
| 465 :Type: *string* | |
| 466 :Global\_Attribute\_Type: Mandatory | |
| 467 :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ | |
| 468 | |
| 469 comment | |
| 470 :Type: *string* | |
| 471 :Global\_Attribute\_Type: Optional | |
| 472 :Description: Any product comments | |
| 473 | |
| 474 scc\_version\_description | |
| 475 :Type: *string* | |
| 476 :Global\_Attribute\_Type: Mandatory | |
| 477 :Description: Extended SCC version description | |
| 478 | |
| 479 scc\_version | |
| 480 :Type: *string* | |
| 481 :Global\_Attribute\_Type: Mandatory | |
| 482 :Description: SCC version number | |
| 483 | |
| 484 processor\_name | |
| 485 :Type: *string* | |
| 486 :Global\_Attribute\_Type: Mandatory | |
| 487 :Description: Name of the processor used to generate the product | |
| 488 | |
| 489 processor\_version | |
| 490 :Type: *string* | |
| 491 :Global\_Attribute\_Type: Mandatory | |
| 492 :Description: Version of the processor used to generate the product | |
| 493 | |
| 494 history | |
| 495 :Type: *string* | |
| 496 :Global\_Attribute\_Type: Mandatory | |
| 497 :Description: Field describing the history of the product | |
| 498 | |
| 499 \_\_file\_format_version | |
| 500 :Type: *string* | |
| 501 :Global\_Attribute\_Type: Mandatory | |
| 502 :Description: Version of the product file format | |
| 503 | |
| 504 data\_processing\_institution | |
| 505 :Type: *string* | |
| 506 :Global\_Attribute\_Type: Mandatory | |
| 507 :Description: Instituion responsible for data processing | |
| 508 | |
| 509 input\_file | |
| 510 :Type: *string* | |
| 511 :Global\_Attribute\_Type: Mandatory | |
| 512 :Description: Filename of the input data product used to generate the current product |
