docs/file_formats/elda_product_format.rst

Thu, 15 Jul 2021 13:13:38 +0200

author
Giuseppe D'Amico <giuseppe.damico@imaa.cnr.it>
date
Thu, 15 Jul 2021 13:13:38 +0200
changeset 130
58bd0b5b6632
parent 125
003aa42747f5
permissions
-rw-r--r--

Added documentation on new optional raw data file global attributa Cloudnet_Station_ID

ELDA Products
----------------

This section describe the structure of ELDA products.


ELPP Products: dimensions
~~~~~~~~~~~~~~~~~~~~~~~~~

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.  

The following dimensions are defined in ELDA products:

-  time
-  altitude
-  wavelength
-  nv 

The dimension *time* (mandatory) specifies the number of vertical profiles included in the product timeseries.

The dimension *altitude* (mandatory) represents the number of rangebins characterizing each vertical profile

The dimension *wavelength* (mandatory) indicates the number wavelengths for which the optical variables are provided

The dimension *nv* (mandatory) is ancillary and it is always set to 2.



ELDA Products: variables
~~~~~~~~~~~~~~~~~~~~~~~~

latitude
    :Type: *float*
    :Dimensions: --
    :Variable\_Type: Mandatory
    :Description: measurement site latitude
    :Units: degrees_north		  
    :Definition: *float latitude*
		 
longitude
    :Type: *float*
    :Dimensions: --
    :Variable\_Type: Mandatory
    :Description: measurement site longitude
    :Units: degrees_east		  
    :Definition: *float longitude*

station\_altitude
   :Type: *float*
   :Dimensions: --
   :Variable\_Type: Mandatory
   :Description: station altitude above see level
   :Units: m
   :Definition: *float station\_altitude*

altitude
   :Type: *double*
   :Dimensions: *altitude*
   :Variable\_Type: Mandatory
   :Description: altitude above see level
   :Units: m		 
   :Definition: *double altitude(altitude)*

time		
   :Type: *double*
   :Dimensions: *time*
   :Variable\_Type: Mandatory	
   :Description: seconds since 1970-01-01T00:00:00Z
   :Units: --		 
   :Definition: *double time(time)* 

time\_bounds
   :Type: *double*
   :Dimensions: *time, nv*
   :Variable\_Type: Mandatory	
   :Description: seconds since 1970-01-01T00:00:00Z
   :Units: --		 
   :Definition: *double time\_bounds(time,nv)*		
		
shots		
   :Type: *int*
   :Dimensions: *time*	  
   :Variable\_Type: Mandatory	
   :Description: accumulated laser shots
   :Units: --		 
   :Definition: *int shots(time)* 

cloud\_mask\_type
   :Type: *byte*
   :Dimensions: --
   :Variable\_Type: Mandatory	
   :Description: Bimask describing the cloudmask type
   :Units: --		 
   :Definition: *byte cloud_mask_type*

cloud\_mask
   :Type: *byte*
   :Dimensions: *time, altitude*
   :Variable\_Type: Optional	
   :Description: Bimask describing the cloudmask
   :Units: --		 
   :Definition: *byte cloud_mask(time, altitude)*

vertical\_resolution
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Mandatory	
   :Description: Effective vertical resolution according to Pappalardo et al., appl. opt. 2004
   :Units: *m*		 
   :Definition: *double vertical\_resolution(wavelength, time, altitude)*
		
               
cirrus\_contamination
   :Type: *byte*
   :Dimensions: --
   :Variable\_Type: Mandatory 	
   :Description: Do the profiles contain cirrus layers?
   :Units: -- 	 
   :Definition: *byte cirrus\_contamination*

cirrus\_contamination\_source                
   :Type: *byte*
   :Dimensions: --
   :Variable\_Type: Mandatory 	
   :Description: How was cirrus_contamination obtained?
   :Units: -- 	 
   :Definition: *byte cirrus\_contamination\_source*


error\_retrieval\_method
   :Type: *byte*
   :Dimensions: *wavelength*
   :Variable\_Type: Mandatory	
   :Description: Method used for the retrieval of erros (uncertainties)
   :Units: -- 	 
   :Definition: *byte error\_retrieval\_method(wavelength)*
		

backscatter\_evaluation\_method
   :Type: *byte*
   :Dimensions: *wavelength*
   :Variable\_Type: Optional	
   :Description: Method used for the backscatter retrieval
   :Units: -- 	 
   :Definition: *byte backscatter\_evaluation\_method(wavelength)*

elastic\_backscatter\_algorithm
   :Type: *byte*
   :Dimensions: *wavelength*
   :Variable\_Type: Optional	
   :Description: Algorithm used for the retrieval of the elastic backscatter profile
   :Units: -- 	 
   :Definition: *byte elastic\_backscatter\_algorithm(wavelength)*



assumed\_particle\_lidar\_ratio		
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Assumed particle lidar ratio for the elastic-only backscatter retrieval
   :Units: *sr*	 
   :Definition: *double assumed\_particle\_lidar\_ratio(wavelength, time, altitude)*
		
               
backscatter
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Particle backscatter coefficient
   :Units: *1/(m\*sr)*	 
   :Definition:	*double backscatter(wavelength, time, altitude)*

error\_backscatter
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Absolute statistical error (unertanity) of particle backscatter coefficient
   :Units: *1/(m\*sr)*	 
   :Definition:	*double error\_backscatter(wavelength, time, altitude)*

extinction
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Particle extinction coefficient
   :Units: *1/m*	 
   :Definition:	*double extinction(wavelength, time, altitude)*

error\_extinction
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Absolute statistical error (unertanity) of particle extinction coefficient
   :Units: *1/m*	 
   :Definition:	*double error\_extinction(wavelength, time, altitude)*

volumedepolarization
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Volume linear depolarization ratio
   :Units: --	 
   :Definition:	*double volumedepolarization(wavelength, time, altitude)*

error\_volumedepolarization
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Absolute statistical error (unertanity) of volume linear depolarization ratio
   :Units: *1/m*	 
   :Definition:	*double error\_volumedepolarization(wavelength, time, altitude)*

particledepolarization
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Particle linear depolarization ratio
   :Units: --	 
   :Definition:	*double particledepolarization(wavelength, time, altitude)*

error\_particledepolarization
   :Type: *double*
   :Dimensions: *wavelength, time, altitude*
   :Variable\_Type: Optional	
   :Description: Absolute statistical error (unertanity) of particle linear depolarization ratio
   :Units: *1/m*	 
   :Definition:	*double error\_particledepolarization(wavelength, time, altitude)*		
		
		  
user\_defined\_category
   :Type: *int* 
   :Dimensions: -- 
   :Variable\_Type: Optional 	
   :Description: User defined category of the measurement
   :Units: -- 	 
   :Definition: *int user\_defined_category*
		
               
molecular\_calculation\_source
   :Type: *byte*
   :Dimensions: -- 
   :Variable\_Type: Mandatory 	
   :Description: Data source of the molecular calculations
   :Units: -- 	 
   :Definition: *byte molecular\_calculation\_source*


backscatter\_calibration\_value
   :Type: *float*
   :Dimensions: *wavelength*
   :Variable\_Type: Optional	
   :Description: Assumed backscatter-ratio value (unitless) in calibration range
   :Units: -- 	 
   :Definition: *float backscatter\_calibration\_value(wavelength)*
              
backscatter\_calibration\_search\_range
   :Type: *float*
   :Dimensions:  *wavelength, nv*
   :Variable\_Type: Optional	
   :Description: Height range wherein calibration range is searched
   :Units: *m* 	 
   :Definition: *float backscatter\_calibration\_search\_range(wavelength, nv)*
               
wavelength
   :Type: *float*
   :Dimensions: *wavelength*
   :Variable\_Type: Mandatory	
   :Description: Wavelength of the transmitted laser pulse
   :Units: *nm* 	 
   :Definition: *float wavelength(wavelength)*
              
zenith\_angle
   :Type: *float*
   :Dimensions: --
   :Variable\_Type: Mandatory 	
   :Description: Laser pointing angle with respect to the zenith
   :Units: *degrees* 	 
   :Definition: *float zenith\_angle*
		

earlinet_product_type		
   :Type: *int*
   :Dimensions: -- 
   :Variable\_Type: Mandatory 	
   :Description: Earlinet product type
   :Units: -- 	 
   :Definition: *int earlinet_product_type*
               
backscatter\_calibration\_range_search\_algorithm
   :Type: *byte*
   :Dimensions: *wavelength*
   :Variable\_Type: Optional	
   :Description: Algorithm used for the search of the calibration_range
   :Units: -- 	 
   :Definition: *byte backscatter\_calibration\_range\_search\_algorithm(wavelength)*



backscatter\_calibration\_range
   :Type: *float*
   :Dimensions: *wavelength, nv*
   :Variable\_Type: Optional	
   :Description: Height range where calibration was calculated
   :Units: *m* 	 
   :Definition: *float backscatter\_calibration\_range(wavelength, nv)*

raman\_backscatter\_algorithm		
   :Type: *byte*
   :Dimensions: *wavelength*
   :Variable\_Type: Optional	
   :Description: Algorithm used for the retrieval of the Raman backscatter profile
   :Units: --	 
   :Definition: *byte raman\_backscatter\_algorithm(wavelength)*

extinction\_evaluation\_algorithm	
   :Type: *byte*
   :Dimensions: *wavelength*
   :Variable\_Type: Optional	
   :Description: Algorithm used for the extinction retrieval
   :Units: --	 
   :Definition: *byte extinction\_evaluation\_algorithm(wavelength)*    

extinction\_assumed\_wavelength\_dependence
   :Type: *float*
   :Dimensions: *wavelength* 
   :Variable\_Type: Optional
   :Description: Assumed wavelength dependence for particle extinction retrieval
   :Definition: *float extinction\_assumed\_wavelength\_dependence(wavelength)*
              
scc\_product\_type
   :Type: *byte*
   :Dimensions: --
   :Variable\_Type: Mandatory
   :Description: Bitmask describing the SCC product type
   :Units: --
   :Definition: *byte scc\_product\_type*	  		
	


ELDA Products: global attributes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Conventions
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: List of the conventions the product is compliant to    
  

title
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Product title  

source
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: String describing the source used to generate the product   

references
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Reference(s) for data processing   																			    
location 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Measurement site location    

station_ID  
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Unique 3 digit code identifying SCC station   
		  
PI 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: PI full name   

PI\_affiliation 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
     :Description: PI complete affiliation    
  
PI\_affiliation_acronym 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: PI affiliation acronym   
    
PI\_address
    :Type: *string*
    :Global\_Attribute\_Type: Optional
    :Description: PI address    
 
PI\_phone 
    :Type: *string*
    :Global\_Attribute\_Type: Optional
    :Description: PI phone number    
 
PI\_email 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: PI e-mail     
   
Data\_Originator 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Data originator full name   
  
Data\_Originator\_affiliation 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Data originator complete affiliation    
 
Data\_Originator\_affiliation\_acronym 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Data originator affiliation acronym    
 
Data\_Originator\_address 
    :Type: *string*
    :Global\_Attribute\_Type: Optional
    :Description: Data originator complete address   
 
Data\_Originator\_phone 
    :Type: *string*
    :Global\_Attribute\_Type: Optional
    :Description: Data originator phone number
  
Data\_Originator\_email
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Data originator e-mail address   

institution 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Istitution the product belong to    
  
system 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Name of the measuring instrument (lidar)    
   
hoi\_system\_ID 
    :Type: *int*
    :Global\_Attribute\_Type: Mandatory
    :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI)    
 
hoi\_configuration\_ID; 
    :Type: *int*
    :Global\_Attribute\_Type: Mandatory
    :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI)    
    
measurement\_ID; 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Alphanumeric identifier for the raw data measurements use to generate the product  
   
measurement\_start\_datetime 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory 
    :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ    
  
measurement\_stop\_datetime 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ    
   
comment 
    :Type: *string*
    :Global\_Attribute\_Type: Optional
    :Description: Any product comments    
 
scc\_version\_description
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Extended SCC version description    
  
scc\_version 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: SCC version number    
  
processor\_name 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Name of the processor used to generate the product    
 
processor\_version 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Version of the processor used to generate the product   
  
history 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Field describing the history of the product    
  
\_\_file\_format_version 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Version of the product file format    
   
data\_processing\_institution 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Instituion responsible for data processing   
  
input\_file 
    :Type: *string*
    :Global\_Attribute\_Type: Mandatory
    :Description: Filename of the input data product used to generate the current product

mercurial