docs/file_formats/cloudscreen_product_format.rst

Thu, 17 Jun 2021 14:09:17 +0200

author
Giuseppe D'Amico <giuseppe.damico@imaa.cnr.it>
date
Thu, 17 Jun 2021 14:09:17 +0200
changeset 128
6757f7d0af2a
parent 125
003aa42747f5
permissions
-rw-r--r--

Updated documetation: new options for Molecular_Calc have been described

giuseppe@125 1 CloudScreen Products
giuseppe@125 2 --------------------
giuseppe@125 3
giuseppe@125 4 This section describe the structure of CloudScreen products.
giuseppe@125 5
giuseppe@125 6
giuseppe@125 7 CloudScreen Products: dimensions
giuseppe@125 8 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
giuseppe@125 9
giuseppe@125 10 The following dimensions are defined in CloudScreen products:
giuseppe@125 11
giuseppe@125 12 - time
giuseppe@125 13 - level
giuseppe@125 14 - nv
giuseppe@125 15
giuseppe@125 16 The dimension *time* (mandatory) specifies the number of cloudmask vertical profiles reported in the products.
giuseppe@125 17
giuseppe@125 18 The dimension *level* (mandatory) represents the number of rangebins characterizing
giuseppe@125 19 each cloudmask verical profile.
giuseppe@125 20
giuseppe@125 21 The dimension *nv* (mandatory) is ancillary and it is always set to 2.
giuseppe@125 22
giuseppe@125 23
giuseppe@125 24
giuseppe@125 25 CloudScreen Products: variables
giuseppe@125 26 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
giuseppe@125 27
giuseppe@125 28 latitude
giuseppe@125 29 :Type: *double*
giuseppe@125 30 :Dimensions: --
giuseppe@125 31 :Variable\_Type: Mandatory
giuseppe@125 32 :Description: measurement site latitude
giuseppe@125 33 :Units: degrees_north
giuseppe@125 34 :Definition: *double latitude*
giuseppe@125 35
giuseppe@125 36 longitude
giuseppe@125 37 :Type: *double*
giuseppe@125 38 :Dimensions: --
giuseppe@125 39 :Variable\_Type: Mandatory
giuseppe@125 40 :Description: measurement site longitude
giuseppe@125 41 :Units: degrees_east
giuseppe@125 42 :Definition: *double longitude*
giuseppe@125 43
giuseppe@125 44 station\_altitude
giuseppe@125 45 :Type: *double*
giuseppe@125 46 :Dimensions: --
giuseppe@125 47 :Variable\_Type: Mandatory
giuseppe@125 48 :Description: station altitude above see level
giuseppe@125 49 :Units: m
giuseppe@125 50 :Definition: *double station\_altitude*
giuseppe@125 51
giuseppe@125 52 altitude
giuseppe@125 53 :Type: *double*
giuseppe@125 54 :Dimensions: *time, level*
giuseppe@125 55 :Variable\_Type: Mandatory
giuseppe@125 56 :Description: altitude above see level
giuseppe@125 57 :Units: m
giuseppe@125 58 :Definition: *double altitude(time, level)*
giuseppe@125 59
giuseppe@125 60 scc\_product\_type
giuseppe@125 61 :Type: *byte*
giuseppe@125 62 :Dimensions: --
giuseppe@125 63 :Variable\_Type: Mandatory
giuseppe@125 64 :Description: Bitmask describing the SCC product type
giuseppe@125 65 :Units: --
giuseppe@125 66 :Definition: *byte scc\_product\_type*
giuseppe@125 67
giuseppe@125 68 time
giuseppe@125 69 :Type: *double*
giuseppe@125 70 :Dimensions: *time*
giuseppe@125 71 :Variable\_Type: Mandatory
giuseppe@125 72 :Description: seconds since 1970-01-01T00:00:00Z
giuseppe@125 73 :Units: --
giuseppe@125 74 :Definition: *double time(time)*
giuseppe@125 75
giuseppe@125 76 time\_bounds
giuseppe@125 77 :Type: *double*
giuseppe@125 78 :Dimensions: *time, nv*
giuseppe@125 79 :Variable\_Type: Mandatory
giuseppe@125 80 :Description: seconds since 1970-01-01T00:00:00Z
giuseppe@125 81 :Units: --
giuseppe@125 82 :Definition: *double time\_bounds(time,nv)*
giuseppe@125 83
giuseppe@125 84 automatic\_cloud\_mask
giuseppe@125 85 :Type: *byte*
giuseppe@125 86 :Dimensions: *time, level*
giuseppe@125 87 :Variable\_Type: Mandatory
giuseppe@125 88 :Description: Automatic cloudmask
giuseppe@125 89 :Units: --
giuseppe@125 90 :Definition: *byte automatic\_cloud\_mask(time, level)*
giuseppe@125 91
giuseppe@125 92 manual\_cloud\_mask
giuseppe@125 93 :Type: *byte*
giuseppe@125 94 :Dimensions: *time, level*
giuseppe@125 95 :Variable\_Type: Optional
giuseppe@125 96 :Description: Manual cloudmask
giuseppe@125 97 :Units: --
giuseppe@125 98 :Definition: *byte manual\_cloud\_mask(time, level)*
giuseppe@125 99
giuseppe@125 100
giuseppe@125 101 CloudScreen Products: global attributes
giuseppe@125 102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
giuseppe@125 103
giuseppe@125 104 Conventions
giuseppe@125 105 :Type: *string*
giuseppe@125 106 :Global\_Attribute\_Type: Mandatory
giuseppe@125 107 :Description: List of the conventions the product is compliant to
giuseppe@125 108
giuseppe@125 109
giuseppe@125 110 title
giuseppe@125 111 :Type: *string*
giuseppe@125 112 :Global\_Attribute\_Type: Mandatory
giuseppe@125 113 :Description: Product title
giuseppe@125 114
giuseppe@125 115 source
giuseppe@125 116 :Type: *string*
giuseppe@125 117 :Global\_Attribute\_Type: Mandatory
giuseppe@125 118 :Description: String describing the source used to generate the product
giuseppe@125 119
giuseppe@125 120 references
giuseppe@125 121 :Type: *string*
giuseppe@125 122 :Global\_Attribute\_Type: Mandatory
giuseppe@125 123 :Description: Reference(s) for data processing
giuseppe@125 124 location
giuseppe@125 125 :Type: *string*
giuseppe@125 126 :Global\_Attribute\_Type: Mandatory
giuseppe@125 127 :Description: Measurement site location
giuseppe@125 128
giuseppe@125 129 station_ID
giuseppe@125 130 :Type: *string*
giuseppe@125 131 :Global\_Attribute\_Type: Mandatory
giuseppe@125 132 :Description: Unique 3 digit code identifying SCC station
giuseppe@125 133
giuseppe@125 134 PI
giuseppe@125 135 :Type: *string*
giuseppe@125 136 :Global\_Attribute\_Type: Mandatory
giuseppe@125 137 :Description: PI full name
giuseppe@125 138
giuseppe@125 139 PI\_affiliation
giuseppe@125 140 :Type: *string*
giuseppe@125 141 :Global\_Attribute\_Type: Mandatory
giuseppe@125 142 :Description: PI complete affiliation
giuseppe@125 143
giuseppe@125 144 PI\_affiliation_acronym
giuseppe@125 145 :Type: *string*
giuseppe@125 146 :Global\_Attribute\_Type: Mandatory
giuseppe@125 147 :Description: PI affiliation acronym
giuseppe@125 148
giuseppe@125 149 PI\_address
giuseppe@125 150 :Type: *string*
giuseppe@125 151 :Global\_Attribute\_Type: Optional
giuseppe@125 152 :Description: PI address
giuseppe@125 153
giuseppe@125 154 PI\_phone
giuseppe@125 155 :Type: *string*
giuseppe@125 156 :Global\_Attribute\_Type: Optional
giuseppe@125 157 :Description: PI phone number
giuseppe@125 158
giuseppe@125 159 PI\_email
giuseppe@125 160 :Type: *string*
giuseppe@125 161 :Global\_Attribute\_Type: Mandatory
giuseppe@125 162 :Description: PI e-mail
giuseppe@125 163
giuseppe@125 164 Data\_Originator
giuseppe@125 165 :Type: *string*
giuseppe@125 166 :Global\_Attribute\_Type: Mandatory
giuseppe@125 167 :Description: Data originator full name
giuseppe@125 168
giuseppe@125 169 Data\_Originator\_affiliation
giuseppe@125 170 :Type: *string*
giuseppe@125 171 :Global\_Attribute\_Type: Mandatory
giuseppe@125 172 :Description: Data originator complete affiliation
giuseppe@125 173
giuseppe@125 174 Data\_Originator\_affiliation\_acronym
giuseppe@125 175 :Type: *string*
giuseppe@125 176 :Global\_Attribute\_Type: Mandatory
giuseppe@125 177 :Description: Data originator affiliation acronym
giuseppe@125 178
giuseppe@125 179 Data\_Originator\_address
giuseppe@125 180 :Type: *string*
giuseppe@125 181 :Global\_Attribute\_Type: Optional
giuseppe@125 182 :Description: Data originator complete address
giuseppe@125 183
giuseppe@125 184 Data\_Originator\_phone
giuseppe@125 185 :Type: *string*
giuseppe@125 186 :Global\_Attribute\_Type: Optional
giuseppe@125 187 :Description: Data originator phone number
giuseppe@125 188
giuseppe@125 189 Data\_Originator\_email
giuseppe@125 190 :Type: *string*
giuseppe@125 191 :Global\_Attribute\_Type: Mandatory
giuseppe@125 192 :Description: Data originator e-mail address
giuseppe@125 193
giuseppe@125 194 institution
giuseppe@125 195 :Type: *string*
giuseppe@125 196 :Global\_Attribute\_Type: Mandatory
giuseppe@125 197 :Description: Istitution the product belong to
giuseppe@125 198
giuseppe@125 199 system
giuseppe@125 200 :Type: *string*
giuseppe@125 201 :Global\_Attribute\_Type: Mandatory
giuseppe@125 202 :Description: Name of the measuring instrument (lidar)
giuseppe@125 203
giuseppe@125 204 hoi\_system\_ID
giuseppe@125 205 :Type: *int*
giuseppe@125 206 :Global\_Attribute\_Type: Mandatory
giuseppe@125 207 :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI)
giuseppe@125 208
giuseppe@125 209 hoi\_configuration\_ID;
giuseppe@125 210 :Type: *int*
giuseppe@125 211 :Global\_Attribute\_Type: Mandatory
giuseppe@125 212 :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI)
giuseppe@125 213
giuseppe@125 214 measurement\_ID;
giuseppe@125 215 :Type: *string*
giuseppe@125 216 :Global\_Attribute\_Type: Mandatory
giuseppe@125 217 :Description: Alphanumeric identifier for the raw data measurements use to generate the product
giuseppe@125 218
giuseppe@125 219 measurement\_start\_datetime
giuseppe@125 220 :Type: *string*
giuseppe@125 221 :Global\_Attribute\_Type: Mandatory
giuseppe@125 222 :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ
giuseppe@125 223
giuseppe@125 224 measurement\_stop\_datetime
giuseppe@125 225 :Type: *string*
giuseppe@125 226 :Global\_Attribute\_Type: Mandatory
giuseppe@125 227 :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ
giuseppe@125 228
giuseppe@125 229 comment
giuseppe@125 230 :Type: *string*
giuseppe@125 231 :Global\_Attribute\_Type: Optional
giuseppe@125 232 :Description: Any product comments
giuseppe@125 233
giuseppe@125 234 scc\_version\_description
giuseppe@125 235 :Type: *string*
giuseppe@125 236 :Global\_Attribute\_Type: Mandatory
giuseppe@125 237 :Description: Extended SCC version description
giuseppe@125 238
giuseppe@125 239 scc\_version
giuseppe@125 240 :Type: *string*
giuseppe@125 241 :Global\_Attribute\_Type: Mandatory
giuseppe@125 242 :Description: SCC version number
giuseppe@125 243
giuseppe@125 244 processor\_name
giuseppe@125 245 :Type: *string*
giuseppe@125 246 :Global\_Attribute\_Type: Mandatory
giuseppe@125 247 :Description: Name of the processor used to generate the product
giuseppe@125 248
giuseppe@125 249 processor\_algorithm
giuseppe@125 250 :Type: *string*
giuseppe@125 251 :Global\_Attribute\_Type: Mandatory
giuseppe@125 252 :Description: Name of the cloudmask algorithm
giuseppe@125 253
giuseppe@125 254 processor\_version
giuseppe@125 255 :Type: *string*
giuseppe@125 256 :Global\_Attribute\_Type: Mandatory
giuseppe@125 257 :Description: Version of the processor used to generate the product
giuseppe@125 258
giuseppe@125 259 history
giuseppe@125 260 :Type: *string*
giuseppe@125 261 :Global\_Attribute\_Type: Mandatory
giuseppe@125 262 :Description: Field describing the history of the product
giuseppe@125 263
giuseppe@125 264 \_\_file\_format_version
giuseppe@125 265 :Type: *string*
giuseppe@125 266 :Global\_Attribute\_Type: Mandatory
giuseppe@125 267 :Description: Version of the product file format
giuseppe@125 268
giuseppe@125 269 data\_processing\_institution
giuseppe@125 270 :Type: *string*
giuseppe@125 271 :Global\_Attribute\_Type: Mandatory
giuseppe@125 272 :Description: Instituion responsible for data processing
giuseppe@125 273
giuseppe@125 274 input\_file
giuseppe@125 275 :Type: *string*
giuseppe@125 276 :Global\_Attribute\_Type: Mandatory
giuseppe@125 277 :Description: Filename of the input data product used to generate the current product
giuseppe@125 278
giuseppe@125 279 automatic\_mask\_channels
giuseppe@125 280 :Type: *string*
giuseppe@125 281 :Global\_Attribute\_Type: Mandatory
giuseppe@125 282 :Description: Channels used to generate the cloumask (SCC channel names)

mercurial