docs/file_formats/cloudscreen_product_format.rst

changeset 125
003aa42747f5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/file_formats/cloudscreen_product_format.rst	Fri Mar 19 13:43:18 2021 +0100
@@ -0,0 +1,282 @@
+CloudScreen Products
+--------------------
+
+This section describe the structure of CloudScreen products.
+
+
+CloudScreen Products: dimensions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following dimensions are defined in CloudScreen products:
+
+-  time
+-  level
+-  nv  
+
+The dimension *time* (mandatory) specifies the number of cloudmask vertical profiles reported in the products.
+
+The dimension *level* (mandatory) represents the number of rangebins characterizing
+each cloudmask verical profile.
+
+The dimension *nv* (mandatory) is ancillary and it is always set to 2.
+
+
+
+CloudScreen 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: *time, level*
+   :Variable\_Type: Mandatory
+   :Description: altitude above see level
+   :Units: m		 
+   :Definition: *double altitude(time, level)*
+
+scc\_product\_type
+   :Type: *byte*
+   :Dimensions: --
+   :Variable\_Type: Mandatory
+   :Description: Bitmask describing the SCC product type
+   :Units: --
+   :Definition: *byte scc\_product\_type*				
+
+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)*
+
+automatic\_cloud\_mask
+   :Type: *byte*
+   :Dimensions: *time, level*
+   :Variable\_Type: Mandatory
+   :Description: Automatic cloudmask
+   :Units: --
+   :Definition:	*byte automatic\_cloud\_mask(time, level)*
+
+manual\_cloud\_mask
+   :Type: *byte*
+   :Dimensions: *time, level*
+   :Variable\_Type: Optional
+   :Description: Manual cloudmask
+   :Units: --
+   :Definition:	*byte manual\_cloud\_mask(time, level)*     
+		
+
+CloudScreen 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\_algorithm
+    :Type: *string*
+    :Global\_Attribute\_Type: Mandatory
+    :Description: Name of the cloudmask algorithm
+ 
+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
+
+automatic\_mask\_channels
+    :Type: *string*
+    :Global\_Attribute\_Type: Mandatory
+    :Description: Channels used to generate the cloumask (SCC channel names)

mercurial