docs/file_formats/eldec_product_format.rst

Thu, 31 Mar 2022 15:12:34 +0300

author
Ioannis Binietoglou <binietoglou@noa.gr>
date
Thu, 31 Mar 2022 15:12:34 +0300
changeset 141
1482e13e0516
parent 125
003aa42747f5
child 142
5367b3cad3fb
permissions
-rw-r--r--

Updated readthedocs.yaml - take 2

ELDEC Products
--------------

This section describe the structure of ELDEC products.


ELDEC Products: dimensions
~~~~~~~~~~~~~~~~~~~~~~~~~~

The following dimensions are defined in ELDEC products:

-  time
-  altitude
-  ratio
-  calibration
-  nv

The dimension *time* (mandatory) specifies the number of calibration performed at different times.

The dimension *altitude* (mandatory) represents the number of rangebins characterizing
the reflected to transmitted polarization calibration ratio.

The dimension *ratio* (mandatory) indicates the number reflected to transmitted ratios included in the product.

The dimension *calibration* indicates the number of calibrations provided by the product.

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



ELDEC Products: variables
~~~~~~~~~~~~~~~~~~~~~~~~~

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

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

range		
   :Type: *double*
   :Dimensions: *altitude*
   :Variable\_Type: Mandatory	
   :Description: lidar range scale
   :Units: m		 
   :Definition: *double range(altitude)* 

shots		
   :Type: *int*
   :Dimensions: *time*	  
   :Variable\_Type: Mandatory	
   :Description: accumulated laser shots
   :Units: --		 
   :Definition: *int shots(time)* 		

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)*            
	
scc\_product\_type
   :Type: *byte*
   :Dimensions: --
   :Variable\_Type: Mandatory
   :Description: Bitmask describing the SCC product type
   :Units: --
   :Definition: *byte scc\_product\_type*	   
		
polarization\_calibration\_ratio\_emission\_wavelength
   :Type: *double*
   :Dimensions: *ratio*
   :Variable\_Type: Mandatory	
   :Description: Emission wavelength of the reflected to transmitted polarization calibration
   :Units: *nm* 		 
   :Definition: *double polarization\_calibration\_ratio\_emission\_wavelength(ratio)*

polarization\_calibration\_ratio\_detection\_wavelength
   :Type: *double*
   :Dimensions: *ratio*
   :Variable\_Type: Mandatory	
   :Description: Detection wavelength of the reflected to transmitted polarization calibration
   :Units: *nm* 		 
   :Definition: *double polarization\_calibration\_ratio\_detection\_wavelength(ratio)*    

polarization\_calibration\_ratio\_range
   :Type: *byte*
   :Dimensions: *ratio*
   :Variable\_Type: Mandatory	
   :Description: Bitmask to identify the reflected to transmitted polarization calibration ratio range type
   :Units: -- 		 
   :Definition: *byte polarization\_calibration\_ratio\_range(ratio)*

polarization\_calibration\_ratio\_configuration
   :Type: *byte*
   :Dimensions: *ratio*
   :Variable\_Type: Mandatory	
   :Description: Bitmask to identify the reflected to transmitted polarization calibration ratio configuration type
   :Units: -- 		 
   :Definition: *byte polarization\_calibration\_ratio\_configuration(ratio)*		

polarization\_calibration\_ratio
   :Type: *double*
   :Dimensions: *ratio, time, altitude*
   :Variable\_Type: Mandatory	
   :Description: Uncalibrated reflected to transmitted polarization calibration ratio
   :Units: -- 		 
   :Definition: *double polarization\_calibration\_ratio(ratio, time, altitude)*

polarization\_calibration\_ratio\_statistical\_error
   :Type: *double*
   :Dimensions: *ratio, time, altitude*
   :Variable\_Type: Mandatory	
   :Description: Statistical error (uncertainty) on uncalibrated reflected to transmitted polarization calibration ratio
   :Units: -- 		 
   :Definition: *double polarization\_calibration\_ratio\_statistical\_error(ratio, time, altitude)*

polarization\_calibration\_ratio\_systematic\_error
   :Type: *double*
   :Dimensions: *ratio, time, altitude*
   :Variable\_Type: Optional	
   :Description: Systematic error (uncertainty) on uncalibrated reflected to transmitted polarization calibration ratio
   :Units: -- 		 
   :Definition: *double polarization\_calibration\_ratio\_statistical\_error(ratio, time, altitude)*  

polarization\_calibration\_minimum\_range
   :Type: *double* 
   :Dimensions: *ratio*
   :Variable\_Type: Mandatory 
   :Description: Minimum altitude to consider for polarization calibration
   :Units: *m* 	 
   :Definition:	 *double polarization\_calibration\_minimum\_range(ratio)*

		 
polarization\_calibration\_maximum\_range
   :Type: *double* 
   :Dimensions: *ratio*
   :Variable\_Type: Mandatory 
   :Description: Maximum altitude to consider for polarization calibration
   :Units: *m* 	 
   :Definition:	*double polarization\_calibration\_maximum\_range(ratio)*     

polarization\_calibration\_ratio\_average
   :Type: *double* 
   :Dimensions: *ratio, time*
   :Variable\_Type: Mandatory
   :Description: Average of the polarization calibration ratio within the calibration range
   :Units: -- 	 
   :Definition:	*double polarization\_calibration\_ratio\_average(ratio, time)*

polarization\_calibration\_ratio\_average\_statistical_error
   :Type: *double* 
   :Dimensions: *ratio, time*
   :Variable\_Type: Mandatory
   :Description: Statistical error (uncertainty) on the average of the polarization calibration ratio within the calibration range
   :Units: -- 	 
   :Definition:	*double polarization\_calibration\_ratio\_average\_statistical\_error(ratio, time)*
      
polarization\_calibration\_ratio\_average\_systematic_error
   :Type: *double* 
   :Dimensions: *ratio, time*
   :Variable\_Type: Optional
   :Description: Systematic error (uncertainty) on the average of the polarization calibration ratio within the calibration range
   :Units: -- 	 
   :Definition:	*double polarization\_calibration\_ratio\_average\_systematic\_error(ratio, time)*		
           
polarization\_gain\_factor\_wavelength
   :Type: *double* 
   :Dimensions: *calibration*
   :Variable\_Type: Mandatory
   :Description: Polarization gain factor wavelength
   :Units: *nm* 	 
   :Definition:	*double polarization\_gain\_factor\_wavelength(calibration)*
		
polarization\_gain\_factor\_range
   :Type: *byte* 
   :Dimensions: *calibration*
   :Variable\_Type: Mandatory
   :Description: Bitmask to describe the polarization gain factor range type
   :Units: --
   :Definition:	*byte polarization\_gain\_factor\_range(calibration)*

		      
polarization\_gain\_factor
   :Type: *double* 
   :Dimensions: *calibration, time*
   :Variable\_Type: Mandatory
   :Description: Polarization gain factor (eta*)
   :Units: -- 	 
   :Definition:	*double polarization\_gain\_factor(calibration, time)*
		
polarization\_gain\_factor\_statistical\_error
   :Type: *double* 
   :Dimensions: *calibration, time*
   :Variable\_Type: Mandatory
   :Description: Statistical error (uncertainty) on polarization gain factor (eta*)
   :Units: -- 	 
   :Definition:	*double polarization\_gain\_factor\_statistical\_error(calibration, time)*

polarization\_gain\_factor\_systematic\_error
   :Type: *double* 
   :Dimensions: *calibration, time*
   :Variable\_Type: Optional
   :Description: Systematic error (uncertainty) on polarization gain factor (eta*)
   :Units: -- 	 
   :Definition:	*double polarization\_gain\_factor\_systematic\_error(calibration, time)*		
		

ELDEC 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