Fri, 11 May 2012 13:25:05 +0200
Restructuring the repository.
% Generated by Sphinx. \def\sphinxdocclass{report} \documentclass[letterpaper,10pt,english]{sphinxmanual} \usepackage[utf8]{inputenc} \DeclareUnicodeCharacter{00A0}{\nobreakspace} \usepackage[T1]{fontenc} \usepackage{babel} \usepackage{times} \usepackage[Bjarne]{fncychap} \usepackage{longtable} \usepackage{sphinx} \usepackage{multirow} \title{Single Calculus Chain Documentation} \date{March 30, 2012} \release{0.2} \author{SCC team} \newcommand{\sphinxlogo}{} \renewcommand{\releasename}{Release} \makeindex \makeatletter \def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax% \let\PYG@ul=\relax \let\PYG@tc=\relax% \let\PYG@bc=\relax \let\PYG@ff=\relax} \def\PYG@tok#1{\csname PYG@tok@#1\endcsname} \def\PYG@toks#1+{\ifx\relax#1\empty\else% \PYG@tok{#1}\expandafter\PYG@toks\fi} \def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{% \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}} \def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}} \def\PYG@tok@gd{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}} \def\PYG@tok@gu{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}} \def\PYG@tok@gt{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.25,0.82}{##1}}} \def\PYG@tok@gs{\let\PYG@bf=\textbf} \def\PYG@tok@gr{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}} \def\PYG@tok@cm{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} \def\PYG@tok@vg{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} \def\PYG@tok@m{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} \def\PYG@tok@mh{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} \def\PYG@tok@cs{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\colorbox[rgb]{1.00,0.94,0.94}{##1}}} \def\PYG@tok@ge{\let\PYG@it=\textit} \def\PYG@tok@vc{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} \def\PYG@tok@il{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} \def\PYG@tok@go{\def\PYG@tc##1{\textcolor[rgb]{0.19,0.19,0.19}{##1}}} \def\PYG@tok@cp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@gi{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}} \def\PYG@tok@gh{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}} \def\PYG@tok@ni{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}} \def\PYG@tok@nl{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}} \def\PYG@tok@nn{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} \def\PYG@tok@no{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}} \def\PYG@tok@na{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@nb{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@nc{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} \def\PYG@tok@nd{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}} \def\PYG@tok@ne{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@nf{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}} \def\PYG@tok@si{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}} \def\PYG@tok@s2{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@vi{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} \def\PYG@tok@nt{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}} \def\PYG@tok@nv{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} \def\PYG@tok@s1{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@gp{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} \def\PYG@tok@sh{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@ow{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@sx{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} \def\PYG@tok@bp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@c1{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} \def\PYG@tok@kc{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@c{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} \def\PYG@tok@mf{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} \def\PYG@tok@err{\def\PYG@bc##1{\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{##1}}} \def\PYG@tok@kd{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@ss{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}} \def\PYG@tok@sr{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}} \def\PYG@tok@mo{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} \def\PYG@tok@mi{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} \def\PYG@tok@kn{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@o{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}} \def\PYG@tok@kr{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@s{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@kp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@w{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}} \def\PYG@tok@kt{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}} \def\PYG@tok@sc{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@sb{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@k{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} \def\PYG@tok@se{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYG@tok@sd{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} \def\PYGZbs{\char`\\} \def\PYGZus{\char`\_} \def\PYGZob{\char`\{} \def\PYGZcb{\char`\}} \def\PYGZca{\char`\^} \def\PYGZsh{\char`\#} \def\PYGZpc{\char`\%} \def\PYGZdl{\char`\$} \def\PYGZti{\char`\~} % for compatibility with earlier versions \def\PYGZat{@} \def\PYGZlb{[} \def\PYGZrb{]} \makeatother \begin{document} \maketitle \tableofcontents \phantomsection\label{index::doc} Contents: \chapter{Introduction} \label{introduction:introduction}\label{introduction:welcome-to-single-calculus-chain-interface-s-documentation}\label{introduction::doc}\begin{itemize} \item {} The Single calculus chain is made of different modules. These modules don't interact directly but only change value in a database. \item {} This interface will allow Earlinet memebers to interact with parts of the database. \item {} One part of the interface (the ``Station admin'' section) permits registering a new station, registerring new lidar systems and configuration, fill in details for the channels that constitute the system and finnaly define the products (extinction, backscatter e.t.c.) that need to be calculated by the SCC. \item {} The second part of the interface is dedicated to the uploading of new measurement files, the configuration of the measurement specific paramters and, finally, the retrieval of the calculated products. \item {} Different types of users, with different level of access permissions can have access in the interface. In this way, higher level of flexibility and security can be achived. \end{itemize} \chapter{Tutorial} \label{tutorial::doc}\label{tutorial:tutorial} \section{Introduction} \label{tutorial/introduction:introduction}\label{tutorial/introduction::doc}\begin{itemize} \item {} The Single calculus chain is made of different modules. These modules don't interact directly but only change value in a database. \item {} This interface will allow Earlinet memebers to interact with parts of the database. \item {} One part of the interface (the ``Station admin'' section) permits registering a new station, registerring new lidar systems and configuration, fill in details for the channels that constitute the system and finnaly define the products (extinction, backscatter e.t.c.) that need to be calculated by the SCC. \item {} The second part of the interface is dedicated to the uploading of new measurement files, the configuration of the measurement specific paramters and, finally, the retrieval of the calculated products. \item {} Different types of users, with different level of access permissions can have access in the interface. In this way, higher level of flexibility and security can be achived. \end{itemize} \section{Adding a station} \label{tutorial/adding_station:adding-a-station}\label{tutorial/adding_station::doc} You can change all your settings throught the \emph{admin section} of the website. To reach it, click on \textbf{Station admin} link at the main menu of the site. \begin{notice}{note}{Note:} You will need to have an account with admin access privilages to access this part of the site. See {\hyperref[user_management:user-management]{\emph{User management}}} for details. \end{notice} The first you have to do to start using the single calculus chain is to register your station. To do this, go the the admin section and click on the \textbf{HOI stations} in the \emph{System settings} panel. This will take you to a page with a list of all stations that you account has access to. This list should be empty if this is the first time you add a station. To add a new station to the database click on \textbf{Add HOI station} at the top right of the screen. This will take you to a new page were you can fill in the needed information. The fields in \textbf{bold} are mandatory and you will need to fill them before you can save you new station. For now you will need to fill in the following fields: \begin{description} \item[{Name}] \leavevmode The name of the station \item[{Id}] \leavevmode The earlinet call sign with exactly 2 characters. \item[{Institute name}] \leavevmode The name of the institute that own the system \item[{Latitude}] \leavevmode In degrees north is the latitude of the station. \item[{Longitude}] \leavevmode In degrees east is the longitude of the station. \item[{Height asl}] \leavevmode The altitude of the station in meters above sea level. \item[{PI}] \leavevmode The name of the Principal Investigator of the station. \end{description} You can leave all the other fields empty. When you are done, press the \textbf{save} button at the bottom right of the page. This will take you back to the list of your stations. If everything went OK your station you just added should appear in the list. We don't have to make any more changes in this part, so you can click on \textbf{Home} on the top left of the page to return to the starting page of the \emph{admin section}. \section{Adding a system} \label{tutorial/adding_system::doc}\label{tutorial/adding_system:adding-a-system} After adding a station to the database, we need to add a new system. To do this, click on the \textbf{HOI systems} in the \emph{System settings} panel. This will take you to a page with a list of all availabe systems that are connected with your stations. This list should be empty if this is the first time you add a system. \begin{notice}{note}{Note:} In the Single Calculus Chain, a \emph{HOI System} represents a specific configuration of a lidar system. For example, if you are operating a lidar system and you use different channels during daytime and nightime, you will need to register \emph{two different} systems in the database, one for each different configuration you use. \end{notice} To add a new system to the database click on \textbf{Add HOI system} at the top right of the screen. This will take you to a new page were you can fill in the needed information. As before, the fields in \textbf{bold} are mandatory and you will need to fill them before you can save you new system. \begin{notice}{note}{Note:} Not every field that is present in the database is used in the in the Single Calculs Chain. Many of them are part of the Handbook of Instruments. \end{notice} For now you will need to fill in the following fields: \begin{description} \item[{Name}] \leavevmode The name of your system. \item[{Station (owner)}] \leavevmode From the drop-down list, select the station which this system belongs to. \item[{Configuration}] \leavevmode The name of the specific configuration. For example you could specify ``night time'' if the system you are registering correspond to the night-time configuration of your system \item[{Pi}] \leavevmode The principle investigator of this system \item[{Height asl}] \leavevmode The altitude of the system above sea level (in meters). \end{description} You can leave all the other fields empty. When you are done, press the \textbf{save} button at the bottom right of the page. This will take you back to the list of your systems. If everything went OK your new system you just added should appear in the list. We don't have to make any more changes in this part, so you can click on \textbf{Home} on the top left of the page to return to the starting page of the \emph{admin section}. \section{Adding equipment} \label{tutorial/adding_telescopelaser:adding-equipment}\label{tutorial/adding_telescopelaser::doc} After adding a system to the database, we need to add at least one telescope and one laser before you add a channel. \subsection{Telescope} \label{tutorial/adding_telescopelaser:telescope} To add a new telescope, click on the \textbf{HOI telescopes} in the \emph{System settings} panel. This will take you to a page with a list of all availabe telescopes that are connected with your station. This list should be empty if this is the first time you add a telescope. To add a new telescope to the database click on \textbf{Add HOI telescope} at the top right of the screen. This will take you to a new page were you can fill in the needed information. Once again, the fields in \textbf{bold} are mandatory and you will need to fill them before you can save you new telescope. The fields you need to add are: \begin{description} \item[{Type}] \leavevmode The telescope type \item[{Diameter}] \leavevmode The diameter of the primary mirror in mm \item[{Focal length}] \leavevmode The equivalent focal length of the telescope in mm \item[{Full overlap height}] \leavevmode The height where the full overlap is achieved. \end{description} When you are done, press the \textbf{save} button at the bottom right of the page. If no errors are present, you will return to the telescope list page. Your new telescope should appear in the list. \subsection{Laser} \label{tutorial/adding_telescopelaser:laser} To add a new laser, click on the \textbf{HOI Laser} in the \emph{System settings} panel. This will take you to a page with a list of all availabe lasers that are connected with your station. This list should be empty if this is the first time you add a laser. To add a new telescope to the database click on \textbf{Add HOI laser} at the top right of the screen. This will take you to a new page were you can fill in the needed information. The fields in \textbf{bold} are mandatory and you will need to fill them before you can save you new telescope. The fields you need to add are: \begin{description} \item[{Manufacturer}] \leavevmode The manufacturer of the telescope \item[{Model}] \leavevmode The model of the telescope \item[{Repetition rate}] \leavevmode The repetition rate in Hz \item[{Type}] \leavevmode The type of the laser (ex. Nd:YAG) \end{description} When you are done, press the \textbf{save} button at the bottom right of the page. If no errors are present, you will return to the laser list page. The new laser you added should be present there. \section{Adding a channel} \label{tutorial/adding_channels::doc}\label{tutorial/adding_channels:adding-a-channel} After adding a system, a telescope and a laser to the database, you need to add a new channel. To do this, click on the \textbf{HOI channels} in the \emph{System settings} panel. This will take you to a page with a list of all availabe channels that are connected with your lidar systems. This list should be empty if this is the first time you add a system. To add a new channel to the database click on \textbf{Add HOI channel} at the top right of the screen. This will take you to a new page were you can fill in the needed information. As before, the fields in \textbf{bold} are mandatory and you will need to fill them before you can save you new system. The fileds you have to fill here are more, as many of these are used during the processing of measurements. \begin{notice}{warning}{Warning:} There is a last step, different from the previous cases, when saving a new channel. You need to connect your channel with a lidar system before you save, or else all your entry will be lost. Read carefully through this document (or directly the {\hyperref[tutorial/adding_channels:connect-channel-to-system]{\emph{last section}}}) to avoid any problems. \end{notice} \subsection{Fill in the fields} \label{tutorial/adding_channels:fill-in-the-fields} To start using the single calculus chain you will need to fill the following fields: \begin{description} \item[{Name}] \leavevmode The name of the channel ex. ``355'', ``1064 analog'' etc. \item[{Telescope}] \leavevmode The telescope that is used for this channel \item[{Laser}] \leavevmode The laser that is used for this channel \item[{Interference filter center}] \leavevmode The center of the interference filter in nm \item[{Interference filter FWHM}] \leavevmode The FWHM of the interference filter in nm \item[{Emission wavelength}] \leavevmode The emission wavelength of the laser used for this channel \item[{Field of view}] \leavevmode The field of view realated to this channel in mrad \item[{Raw range resolution}] \leavevmode The raw range resolution of the measured data in m \item[{Dead time}] \leavevmode The dead of the detector in ns. You should fill in this in case of a photon counting detector. \item[{Trigger delay}] \leavevmode The trigger delay value for the channel in ns. Fill in 0 if not needed. \item[{Scattering mechanism}] \leavevmode The scattering mechanism that is involved in this channel. Select the appropriate value from the drop-down list. \item[{Dead time correction type}] \leavevmode The dead time correction type to be applied. Select \emph{Not defined} if none needs to be defined. \item[{Background mode}] \leavevmode The way to calculate the singal background. Select \emph{Not defined} if none needs to be defined. \item[{Signal type}] \leavevmode The type of the singal that is measured, ex. ``elT'' for total elastic, ``vrRN2'' for vibrational-rotational Raman signal from Nitrogen melecules etc. See {\hyperref[details/adding_channels:signal-types]{\emph{Signal types}}} for details. \item[{Detection mode}] \leavevmode The detection mode of this channel. \end{description} \subsection{Connecting to a system} \label{tutorial/adding_channels:connect-channel-to-system}\label{tutorial/adding_channels:connecting-to-a-system} Before you finish, you need to attach your channel to one of your systems. To do this, go at the bottom of the page and select your system from the drop-down list in the \textbf{System channels} area. When you are done, press the \textbf{save} button at the bottom right of the page. This will take you back to the list of your channels. If everything went OK your new channel you just added should appear in the list. \section{Adding products} \label{tutorial/adding_products:adding-products}\label{tutorial/adding_products::doc} Walk-through of adding a product. \section{Processing data} \label{tutorial/processing_data:processing-data}\label{tutorial/processing_data::doc} Walk-through of how to upload a file and seeing the results. \chapter{Detailed documentation} \label{interface_details::doc}\label{interface_details:detailed-documentation} Contents: \section{Introduction} \label{details/introduction:introduction}\label{details/introduction::doc} \section{Adding stations} \label{details/adding_station:adding-stations}\label{details/adding_station::doc} You can add the definition of new systems that belong to the station by clicking on the Hoi System blue line that appears bollow the main station fields. For more details on the filed you need to fill in see the {\hyperref[details/adding_system:add-new-system]{\emph{Adding systems}}} section. You can add more stations by clicking on the ``Add another Hoi System'' option. \begin{notice}{note}{Note:} You need to have \emph{Javascript} enebled to add a new station from this page. \end{notice} \section{Adding systems} \label{details/adding_system:add-new-system}\label{details/adding_system:adding-systems}\label{details/adding_system::doc} \section{Adding channels} \label{details/adding_channels::doc}\label{details/adding_channels:adding-channels} \subsection{Signal types} \label{details/adding_channels:signal-types}\label{details/adding_channels:id1} (explain here all the signal type abreviations). \section{Adding products} \label{details/adding_products:adding-products}\label{details/adding_products::doc} \section{Adding other equipment} \label{details/adding_otherequipment:adding-other-equipment}\label{details/adding_otherequipment::doc} \section{The Handbook of instruments} \label{details/handbook_of_instruments:the-handbook-of-instruments}\label{details/handbook_of_instruments::doc} \section{Uploading measuremnents} \label{details/uploading_measurements:uploading-measuremnents}\label{details/uploading_measurements::doc} 123 \section{View processing results} \label{details/viewing_measurements:view-processing-results}\label{details/viewing_measurements::doc} 123 \chapter{The SCC netCDF file format} \label{netcdf_file:the-scc-netcdf-file-format}\label{netcdf_file::doc} \section{Rationale} \label{netcdf_file:rationale} The Single Calculus Chain (SCC) is composed by two different modules: \begin{itemize} \item {} pre-processing module ( scc\_preprocessing) \item {} optical processing module ( ELDA) \end{itemize} To perfom aerosol optical retrievals the SCC needs not only the raw lidar data but also a certain number of parameters to use in both pre-processing and optical processing stages. The SCC gets these parameters looking at two different locations: \begin{itemize} \item {} Single Calculus Chain relational database (SCC\_DB) \item {} Input files \end{itemize} There are some paramenters that can be found only in the input files (those ones changing from measurement to measurement), others that can be found only in the SCC\_DB and other ones that can be found in both these locations. In the last case, if a particular parameter is needed, the SCC will search first in the input files and then in SCC\_DB. If the parameter is found in the input files the SCC will keep it without looking into SCC\_DB. The input files have to be submitted to the SCC in NetCDF format. At the present the SCC can handle four different types of input files: \begin{enumerate} \item {} Raw Lidar Data \item {} Sounding Data \item {} Overlap \item {} Lidar Ratio \end{enumerate} As already mentioned, the Raw Lidar Data file contains not only the raw lidar data but also other parameters to use to perform the pre-processing and optical processing. The Sounding Data file contains the data coming from a correlative radiosounding and it is used by the SCC for molecular density calculation. The Overlap file contains the measured overlap function. The Lidar Ratio file contains a lidar ratio profile to use in elastic backscatter retrievals. The Raw Lidar Data file is of course mandatory and the Sounding Data, Overlap and Lidar Ratio files are optional. If Sounding Data file is not submitted by the user, the molecular density will be calculated by the SCC using the “US Standard Atmosphere 1976”. If the Overlap file is not submitted by the user, the SCC will get the full overlap height from SCC\_DB and it will produce optical results starting from this height. If Lidar Ratio file is not submitted by the user, the SCC will consider a fixed value for lidar ratio got from SCC\_DB. The user can decide to submit all these files or any number of them (of course the file Raw Lidar Data is mandatory). For example the user can submit together with the Raw Lidar Data file only the Sounding Data file or only the Overlap file. This document provides a detailed explanation about the structure of the NetCDF input files to use for SCC data submission. All Earlinet groups should read it carefully because they have to produce such kind of input files if they want to use the SCC for their standard lidar retrievals. Every comments or suggestions regarding this document can be sent to Giuseppe D’Amico by e-mail at \code{damico@imaa.cnr.it} This document is available for downloading at \code{www.earlinetasos.org} In table tab:rawdata is reported a list of dimensions, variables and global attributes that can be used in the NetCDF Raw Lidar Data input file. For each of them it is indicated: \begin{itemize} \item {} The name. For the multidimensional variables also the corresponding dimensions are reported \item {} A description explaining the meaning \item {} The type \item {} If it is mandatory or optional \end{itemize} As already mentioned, the SCC can get some parameters looking first in the Raw Lidar Data input file and then into SCC\_DB. This means that to use the parameters stored in SCC\_DB the optional variables or optional global attributes must not appear within Raw Lidar Data file. This is the suggested and recommended way to use the SCC. Please include optional parameters in the Raw Lidar Data only as an exception. In table tab:sounding, tab:overlap and tab:lr are reported all the information about the structure of Sounding Data, Overlap and Lidar Ratio input files respectively. \section{Example} \label{netcdf_file:example} Let’s now consider an example of Raw Lidar Data input file. Suppose we want to generate NetCDF input file corresponding to a measurement with the following properties: \begin{tabulary}{\linewidth}{|L|L|} \hline Start Date & $30^{th}$ January 2009 \\\hline Start Time UT & 00:00:01 \\\hline Stop Time UT & 00:05:01 \\\hline Station Name & Dummy station \\\hline Earlinet call-sign & cc \\\hline Pointing angle & 5 degrees with respect to the zenith \\\hline \end{tabulary} Moreover suppose that this measurement is composed by the following lidar channels: \begin{enumerate} \item {} 1064 lidar channel \begin{tabulary}{\linewidth}{|L|L|} \hline Emission wavelength=1064nm & Detection wavelength=1064nm \\\hline Time resolution=30s & Number of laser shots=1500 \\\hline Number of bins=3000 & Detection mode=analog \\\hline Range resolution=7.5m & Polarization state=total \\\hline \end{tabulary} \item {} 532 cross lidar channel \begin{tabulary}{\linewidth}{|L|L|} \hline Emission wavelength=532nm & Detection wavelength=532nm \\\hline Time resolution=60s & Number of laser shots=3000 \\\hline Number of bins=5000 & Detection mode=photoncounting \\\hline Range resolution=15m & Polarization state=cross \\\hline \end{tabulary} \item {} 532 parallel lidar channel \begin{tabulary}{\linewidth}{|L|L|} \hline Emission wavelength=532nm & Detection wavelength=532nm \\\hline Time resolution=60s & Number of laser shots=3000 \\\hline Number of bins=5000 & Detection mode=photoncounting \\\hline Range resolution=15m & Polarization state=parallel \\\hline \end{tabulary} \item {} 607 $N_2$ vibrational Raman channel \begin{tabulary}{\linewidth}{|L|L|} \hline Emission wavelength=532nm & Detection wavelength=607nm \\\hline Time resolution=60s & Number of laser shots=3000 \\\hline Number of bins=5000 & Detection mode=photoncounting \\\hline \multicolumn{2}{|l|}{ Range resolution=15m }\\\hline \end{tabulary} \end{enumerate} Finally let’s assume we have also performed dark measurements before the lidar measurements from the 23:50:01 UT up to 23:53:01 UT of 29:math:\emph{\textasciicircum{}mathrmth} January 2009. \subsection{Dimensions} \label{netcdf_file:dimensions} Looking at table tab:rawdata we have to fix the following dimensions: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{points} \PYG{n}{channels} \PYG{n}{time} \PYG{n}{nb\PYGZus{}of\PYGZus{}time\PYGZus{}scales} \PYG{n}{scan\PYGZus{}angles} \PYG{n}{time\PYGZus{}bck} \end{Verbatim} The dimension \code{time} is unlimited so we don’t have to fix it. We have 4 lidar channels so: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{channels}\PYG{o}{=}\PYG{l+m+mi}{4} \end{Verbatim} Regarding the dimension \code{points} we have only one channel with a number of vertical bins equal to 3000 (the 1064nm) and all other channels with 5000 vertical bins. In cases like this the dimension \code{points} has to be fixed to the maximum number of vertical bins so: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{points}\PYG{o}{=}\PYG{l+m+mi}{5000} \end{Verbatim} Moreover only one channel (1064nm) is acquired with a time resolution of 30 seconds, all the other channels have a time resolution of 60 seconds. This means that we have to define two different time scales. We have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{nb\PYGZus{}of\PYGZus{}time\PYGZus{}scales}\PYG{o}{=}\PYG{l+m+mi}{2} \end{Verbatim} The measurement is performed only at one scan angle (5 degrees with respect to the zenith) so: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{scan\PYGZus{}angles}\PYG{o}{=}\PYG{l+m+mi}{1} \end{Verbatim} We have 3 minutes of dark measurements and two different time scales one with 60 seconds time resolution and the other one with 30 seconds time resolution. So we will have 3 different dark profiles for the channels acquired with the first time scale and 6 for the lidar channels acquired with the second time scale. We have to fix the dimension \code{time\_bck} as the maximum between these values: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{time\PYGZus{}bck}\PYG{o}{=}\PYG{l+m+mi}{6} \end{Verbatim} \subsection{Variables} \label{netcdf_file:variables} In this section it will be explained how to fill all the possible variables either mandatory or optional of Raw Lidar Data input file. \begin{description} \item[{Raw\_Data\_Start\_Time(time, nb\_of\_time\_scales)}] \leavevmode This 2 dimensional mandatory array has to contain the acquisition start time (in seconds from the time given by the global attribute \code{RawData\_Start\_Time\_UT}) of each lidar profile. In this example we have two different time scales: one is characterized by steps of 30 seconds (the 1064nm is acquired with this time scale) the other by steps of 60 seconds (532cross, 532parallel and 607nm). Moreover the measurement start time is 00:00:01 UT and the measurement stop time is 00:05:01 UT. In this case we have to define: \begin{Verbatim}[commandchars=\\\{\}] Raw\_Data\_Start\_Time = 0, 0, 60, 30, 120, 60, 180, 90, 240, 120, \_, 150, \_, 180, \_, 210, \_, 240, \_, 270 ; \end{Verbatim} The order used to fill this array defines the correspondence between the different time scales and the time scale index. In this example we have a time scale index of 0 for the time scale with steps of 60 seconds and a time scale index of 1 for the other one. \item[{Raw\_Data\_Stop\_Time(time, nb\_of\_time\_scales)}] \leavevmode The same as previous item but for the data acquisition stop time. Following a similar procedure we have to define: \begin{Verbatim}[commandchars=\\\{\}] Raw\_Data\_Stop\_Time = 60, 30, 120, 60, 180, 90, 240, 120, 300, 150, \_, 180, \_, 210, \_, 240, \_, 270, \_, 300 ; \end{Verbatim} \item[{Raw\_Lidar\_Data(time, channels, points)}] \leavevmode This 3 dimensional mandatory array has to be filled with the time-series of raw lidar data. The photoncounting profiles have to submitted in counts (so as integers) while the analog ones in mV. The order the user chooses to fill this array defines the correspondence between channel index and lidar data. For example if we fill this array in such way that: \begin{tabulary}{\linewidth}{|L|L|} \hline Raw\_Lidar\_Data(time,0,points & $\rightarrow$ is the time-series of 1064 nm \\\hline Raw\_Lidar\_Data(time,1,points & $\rightarrow$ is the time-series of 532 cross \\\hline Raw\_Lidar\_Data(time,2,points & $\rightarrow$ is the time-series of 532 parallel \\\hline Raw\_Lidar\_Data(time,3,points & $\rightarrow$ is the time-series of 607 nm \\\hline \end{tabulary} from now on the channel index 0 is associated to the 1064 channel, 1 to the 532 cross, 2 to the 532 parallel and 3 to the 607nm. \item[{Raw\_Bck\_Start\_Time(time\_bck, nb\_of\_time\_scales)}] \leavevmode This 2 dimensional optional array has to contain the acquisition start time (in seconds from the time given by the global attribute \code{RawBck\_Start\_Time\_UT}) of each dark measurements profile. Following the same procedure used for the variable \code{Raw\_Data\_Start\_Time} we have to define: \begin{Verbatim}[commandchars=\\\{\}] Raw\_Bck\_Start\_Time = 0, 0, 60, 30, 120, 60, \_, 90, \_, 120, \_, 150; \end{Verbatim} \item[{Raw\_Bck\_Stop\_Time(time\_bck, nb\_of\_time\_scales)}] \leavevmode The same as previous item but for the dark acquisition stop time. Following a similar procedure we have to define: \begin{Verbatim}[commandchars=\\\{\}] Raw\_Bck\_Stop\_Time = 60, 30, 120, 60, 180, 90, \_, 120, \_, 150, \_, 180 ; \end{Verbatim} \item[{Background\_Profile(time\_bck, channels, points)}] \leavevmode This 3 dimensional optional array has to be filled with the time-series of the dark measurements data. The photoncounting profiles have to submitted in counts (so as integers) while the analog ones in mV. The user has to fill this array following the same order used in filling the array \code{Raw\_Lidar\_Data}: \begin{tabulary}{\linewidth}{|L|L|} \hline Background\_Profile(time\_bck,0,points & $\rightarrow$ dark time-series at 1064 nm \\\hline Background\_Profile(time\_bck,1,points & $\rightarrow$ dark time-series at 532 cross \\\hline Background\_Profile(time\_bck,2,points & $\rightarrow$ dark time-series at 532 parallel \\\hline Background\_Profile(time\_bck,3,points & $\rightarrow$ dark time-series at 607 nm \\\hline \end{tabulary} \item[{channel\_ID(channels)}] \leavevmode This mandatory array provides the link between the channel index within the Raw Lidar Data input file and the channel ID in SCC\_DB. To fill this variable the user has to know which channel IDs in SCC\_DB correspond to his lidar channels. For this purpose the SCC, in its final version will provide to the user a special tool to get these channel IDs through a Web interface. At the moment this interface is not yet available and these channel IDs will be communicated directly to the user by the NA5 people. Anyway to continue the example let’s suppose that the four lidar channels taken into account are mapped into SCC\_DB with the following channel IDs: \begin{tabulary}{\linewidth}{|L|L|} \hline 1064 nm & $\rightarrow$ channel ID=7 \\\hline 532 cross & $\rightarrow$ channel ID=5 \\\hline 532 parallel & $\rightarrow$ channel ID=6 \\\hline 607 nm & $\rightarrow$ channel ID=8 \\\hline \end{tabulary} \begin{quote} In this case we have to define: \end{quote} \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{channel\PYGZus{}ID} \PYG{o}{=} \PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{l+m+mi}{8} \PYG{p}{;} \end{Verbatim} \item[{id\_timescale(channels)}] \leavevmode This mandatory array is introduced to determine which time scale is used for the acquisition of each lidar channel. In particular this array defines the link between the channel index and the time scale index. In our example we have two different time scales. Filling the arrays \code{Raw\_Data\_Start\_Time} and \code{Raw\_Data\_Stop\_Time} we have defined a time scale index of 0 for the time scale with steps of 60 seconds and a time scale index of 1 for the other one with steps of 30 seconds. In this way this array has to be set as: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{id\PYGZus{}timescale} \PYG{o}{=} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0} \PYG{p}{;} \end{Verbatim} \item[{Laser\_Pointing\_Angle(scan\_angles}] \leavevmode This mandatory array contains all the scan angles used in the measurement. In our example we have only one scan angle of 5 degrees with respect to the zenith, so we have to define: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Laser\PYGZus{}Pointing\PYGZus{}Angle} \PYG{o}{=} \PYG{l+m+mi}{5} \PYG{p}{;} \end{Verbatim} \item[{Laser\_Pointing\_Angle\_of\_Profiles(time, nb\_of\_time\_scales)}] \leavevmode This mandatory array is introduced to determine which scan angle is used for the acquisition of each lidar profile. In particular this array defines the link between the time and time scales indexes and the scan angle index. In our example we have a single scan angle that has to correspond to the scan angle index 0. So this array has to be defined as: \begin{Verbatim}[commandchars=\\\{\}] Laser\_Pointing\_Angle\_of\_Profiles = 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \_, 0, \_, 0, \_, 0, \_, 0, \_, 0 ; \end{Verbatim} \item[{Laser\_Shots(time, channels)}] \leavevmode This mandatory array stores the laser shots accumulated at each time for each channel. In our example the number of laser shots accumulated is 1500 for the 1064nm channels and 3000 for all the other channels. Moreover the laser shots do not change with the time. So we have to define this array as: \begin{Verbatim}[commandchars=\\\{\}] Laser\_Shots = 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_ ; \end{Verbatim} \item[{Emitted\_Wavelength(channels)}] \leavevmode This optional array defines the link between the channel index and the emission wavelength for each lidar channel. The wavelength has to be expressed in nm. This information can be also taken from SCC\_DB. In our example we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Emitted\PYGZus{}Wavelength} \PYG{o}{=} \PYG{l+m+mi}{1064}\PYG{p}{,} \PYG{l+m+mi}{532}\PYG{p}{,} \PYG{l+m+mi}{532}\PYG{p}{,} \PYG{l+m+mi}{532} \PYG{p}{;} \end{Verbatim} \item[{Detected\_Wavelength(channels)}] \leavevmode This optional array defines the link between the channel index and the detected wavelength for each lidar channel. Here detected wavelength means the value of center of interferential filter expressed in nm. This information can be also taken from SCC\_DB. In our example we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Detected\PYGZus{}Wavelength} \PYG{o}{=} \PYG{l+m+mi}{1064}\PYG{p}{,} \PYG{l+m+mi}{532}\PYG{p}{,} \PYG{l+m+mi}{532}\PYG{p}{,} \PYG{l+m+mi}{607} \PYG{p}{;} \end{Verbatim} \item[{Raw\_Data\_Range\_Resolution(channels)}] \leavevmode This optional array defines the link between the channel index and the raw range resolution for each channel. If the scan angle is different from zero this quantity is different from the vertical resolution. More precisely if $\alpha$ is the scan angle used and $\Delta z$ is the range resolution the vertical resolution is calculated as $\Delta z'=\Delta z \cos\alpha$. This array has to be filled with $\Delta z$ and not with $\Delta z'$. The unit is meters. This information can be also taken from SCC\_DB. In our example we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Raw\PYGZus{}Data\PYGZus{}Range\PYGZus{}Resolution} \PYG{o}{=} \PYG{l+m+mf}{7.5}\PYG{p}{,} \PYG{l+m+mf}{15.0}\PYG{p}{,} \PYG{l+m+mf}{15.0}\PYG{p}{,} \PYG{l+m+mf}{15.0} \PYG{p}{;} \end{Verbatim} \item[{ID\_Range(channels)}] \leavevmode This optional array defines if a particular channel is configured as high, low or ultranear range channel. In particular a value 0 indicates a low range channel, a value 1 a high range channel and a value of 2 an ultranear range channel. If for a particular channel you don’t separate between high and low range channel, please set the corresponding value to 1. This information can be also taken from SCC\_DB. In our case we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{ID\PYGZus{}Range} \PYG{o}{=} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{1} \PYG{p}{;} \end{Verbatim} \item[{Scattering\_Mechanism(channels)}] \leavevmode This optional array defines the scattering mechanism involved in each lidar channel. In particular the following values are adopted: \begin{tabulary}{\linewidth}{|L|L|} \hline 0 & $\rightarrow$ Total elastic backscatter \\\hline 1 & $\rightarrow$ $N_2$ vibrational Raman backscatter \\\hline 2 & $\rightarrow$ Cross polarization elastic backscatter \\\hline 3 & $\rightarrow$ Parallel polarization elastic backscatter \\\hline 4 & $\rightarrow$ $H_2O$ vibrational Raman backscatter \\\hline 5 & $\rightarrow$ Rotational Raman Stokes line close to elastic line \\\hline 6 & $\rightarrow$ Rotational Raman Stokes line far from elastic line \\\hline 7 & $\rightarrow$ Rotational Raman anti-Stokes line close to elastic line \\\hline 8 & $\rightarrow$ Rotational Raman anti-Stokes line far from elastic line \\\hline 9 & $\rightarrow$ Rotational Raman Stokes and anti-Stokes lines close to elastic line \\\hline 10 & $\rightarrow$ Rotational Raman Stokes and anti-Stokes lines far from elastic line \\\hline \end{tabulary} This information can be also taken from SCC\_DB. In our example we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Scattering\PYGZus{}Mechanism} \PYG{o}{=} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{,} \PYG{l+m+mi}{1} \PYG{p}{;} \end{Verbatim} \item[{Acquisition\_Mode(channels)}] \leavevmode This optional array defines the acquisition mode (analog or photoncounting) involved in each lidar channel. In particular a value of 0 means analog mode and 1 photoncounting mode. This information can be also taken from SCC\_DB. In our example we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Acquisition\PYGZus{}Mode} \PYG{o}{=} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{1} \PYG{p}{;} \end{Verbatim} \item[{Laser\_Repetition\_Rate(channels)}] \leavevmode This optional array defines the repetition rate in Hz used to acquire each lidar channel. This information can be also taken from SCC\_DB. In our example we are supposing we have only one laser with a repetition rate of 50 Hz so we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Laser\PYGZus{}Repetition\PYGZus{}Rate} \PYG{o}{=} \PYG{l+m+mi}{50}\PYG{p}{,} \PYG{l+m+mi}{50}\PYG{p}{,} \PYG{l+m+mi}{50}\PYG{p}{,} \PYG{l+m+mi}{50} \PYG{p}{;} \end{Verbatim} \item[{Dead\_Time(channels)}] \leavevmode This optional array defines the dead time in ns associated to each lidar channel. The SCC will use the values given by this array to correct the photoncounting signals for dead time. Of course for analog signals no dead time correction will be applied (for analog channels the corresponding dead time values have to be set to undefined value). This information can be also taken from SCC\_DB. In our example the 1064 nm channel is acquired in analog mode so the corresponding dead time value has to be undefined. If we suppose a dead time of 10 ns for all other channels we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Dead\PYGZus{}Time} \PYG{o}{=} \PYG{n}{\PYGZus{}}\PYG{p}{,} \PYG{l+m+mi}{10}\PYG{p}{,} \PYG{l+m+mi}{10}\PYG{p}{,} \PYG{l+m+mi}{10} \PYG{p}{;} \end{Verbatim} \item[{Dead\_Time\_Corr\_Type(channels}] \leavevmode This optional array defines which kind of dead time correction has to be applied on each photoncounting channel. The SCC will correct the data supposing a not-paralyzable channel if a value of 0 is found while a paralyzable channel is supposed if a value of 1 is found. Of course for analog signals no dead time correction will be applied and so the corresponding values have to be set to undefined value. This information can be also taken from SCC\_DB. In our example the 1064 nm channel is acquired in analog mode so the corresponding has to be undefined. If we want to consider all the photoncounting signals as not-paralyzable ones: we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Dead\PYGZus{}Time\PYGZus{}Corr\PYGZus{}Type} \PYG{o}{=} \PYG{n}{\PYGZus{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0} \PYG{p}{;} \end{Verbatim} \item[{Trigger\_Delay(channels)}] \leavevmode This optional array defines the delay (in ns) of the middle of the first rangebin with respect to the output laser pulse for each lidar channel. The SCC will use the values given by this array to correct for trigger delay. This information can be also taken from SCC\_DB. Let’s suppose that in our example all the photoncounting channels are not affected by this delay and only the analog channel at 1064nm is acquired with a delay of 50ns. In this case we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Trigger\PYGZus{}Delay} \PYG{o}{=} \PYG{l+m+mi}{50}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0} \PYG{p}{;} \end{Verbatim} \item[{Background\_Mode(channels}] \leavevmode This optional array defines how the atmospheric background has to be subtracted from the lidar channel. Two options are available for the calculation of atmospheric background: \begin{enumerate} \item {} Average in the far field of lidar channel. In this case the value of this variable has to be 1 \item {} Average within pre-trigger bins. In this case the value of this variable has to be 0 \end{enumerate} This information can be also taken from SCC\_DB. Let’s suppose in our example we use the pre-trigger for the 1064nm channel and the far field for all other channels. In this case we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Background\PYGZus{}Mode} \PYG{o}{=} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{1} \PYG{p}{;} \end{Verbatim} \item[{Background\_Low(channels)}] \leavevmode This mandatory array defines the minimum altitude (in meters) to consider in calculating the atmospheric background for each channel. In case pre-trigger mode is used the corresponding value has to be set to the rangebin to be used as lower limit (within pre-trigger region) for background calculation. In our example, if we want to calculate the background between 30000 and 50000 meters for all photoncounting channels and we want to use the first 500 pre-trigger bins for the background calculation for the 1064nm channel we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Background\PYGZus{}Low}\PYG{o}{=} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30000}\PYG{p}{,} \PYG{l+m+mi}{30000}\PYG{p}{,} \PYG{l+m+mi}{30000} \PYG{p}{;} \end{Verbatim} \item[{Background\_High(channels)}] \leavevmode This mandatory array defines the maximum altitude (in meters) to consider in calculating the atmospheric background for each channel. In case pre-trigger mode is used the corresponding value has to be set to the rangebin to be used as upper limit (within pre-trigger region) for background calculation. In our example, if we want to calculate the background between 30000 and 50000 meters for all photoncounting channels and we want to use the first 500 pre-trigger bins for the background calculation for the 1064nm channel we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Background\PYGZus{}High} \PYG{o}{=} \PYG{l+m+mi}{500}\PYG{p}{,} \PYG{l+m+mi}{50000}\PYG{p}{,} \PYG{l+m+mi}{50000}\PYG{p}{,} \PYG{l+m+mi}{50000} \PYG{p}{;} \end{Verbatim} \item[{Molecular\_Calc}] \leavevmode This mandatory variable defines the way used by SCC to calculate the molecular density profile. At the moment two options are available: \begin{enumerate} \item {} US Standard Atmosphere 1976. In this case the value of this variable has to be 0 \item {} Radiosounding. In this case the value of this variable has to be 1 \end{enumerate} If we decide to use the option 1. we have to provide also the measured pressure and temperature at lidar station level. Indeed if we decide to use the option 2. a radiosounding file has to be submitted separately in NetCDF format (the structure of this file is summarized in table tab:sounding). Let’s suppose we want to use the option 1. so: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Molecular\PYGZus{}Calc} \PYG{o}{=} \PYG{l+m+mi}{0} \PYG{p}{;} \end{Verbatim} \item[{Pressure\_at\_Lidar\_Station}] \leavevmode Because we have chosen the US Standard Atmosphere for calculation of the molecular density profile we have to give the pressure in hPa at lidar station level: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Pressure\PYGZus{}at\PYGZus{}Lidar\PYGZus{}Station} \PYG{o}{=} \PYG{l+m+mi}{1010} \PYG{p}{;} \end{Verbatim} \item[{Temperature\_at\_Lidar\_Station}] \leavevmode Because we have chosen the US Standard Atmosphere for calculation of the molecular density profile we have to give the temperature in C at lidar station level: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Temperature\PYGZus{}at\PYGZus{}Lidar\PYGZus{}Station} \PYG{o}{=} \PYG{l+m+mf}{19.8} \PYG{p}{;} \end{Verbatim} \item[{Depolarization\_Factor(channels)}] \leavevmode This array is required only for lidar systems that use the two depolarization channels for the backscatter retrieval. It represents the factor $f$ to calculate the total backscatter signal $S_t$ combining its cross $S_c$ and parallel $S_p$ components: $S_t=S_p+fS_c$. This factor is mandatory only for systems acquiring $S_c$ and $S_p$ and not $S_t$. For systems acquiring $S_c$, $S_p$ and $S_t$ this factor is optional and it will be used only for depolarizaton ratio calculation. Moreover only the values of the array corresponding to cross polarization channels will be considered; all other values will be not taken into account and should be set to undefined value. In our example for the wavelength 532nm we have only the cross and the parallel components and not the total one. So we have to give the value of this factor only in correspondence of the 532nm cross polarization channel that corresponds to the channel index 1. Suppose that this factor is 0.88. Moreover, because we don’t have any other depolarization channels we have also to set all other values of the array to undefined value. \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Depolarization\PYGZus{}Factor} \PYG{o}{=} \PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{l+m+mf}{0.88}\PYG{p}{,}\PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{n}{\PYGZus{}} \PYG{p}{;} \end{Verbatim} \item[{LR\_Input(channels)}] \leavevmode This array is required only for lidar channels for which elastic backscatter retrieval has to be performed. It defines the lidar ratio to be used within this retrieval. Two options are available: \begin{enumerate} \item {} The user can submit a lidar ratio profile. In this case the value of this variable has to be 0. \item {} A fixed value of lidar ratio can be used. In this case the value of this variable has to be 1. \end{enumerate} If we decide to use the option 1. a lidar ratio file has to be submitted separately in NetCDF format (the structure of this file is summarized in table tab:lr). If we decide to use the option 2. the fixed value of lidar ratio will be taken from SCC\_DB. In our example we have to give a value of this array only for the 1064nm lidar channel because for the 532nm we will be able to retrieve a Raman backscatter coefficient. In case we want to use the fixed value stored in SCC\_DB we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{LR\PYGZus{}Input} \PYG{o}{=} \PYG{l+m+mi}{1}\PYG{p}{,}\PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{n}{\PYGZus{}} \PYG{p}{;} \end{Verbatim} \item[{DAQ\_Range(channels)}] \leavevmode This array is required only if one or more lidar signals are acquired in analog mode. It gives the analog scale in mV used to acquire the analog signals. In our example we have only the 1064nm channel acquired in analog mode. If we have used a 100mV analog scale to acquire this channel we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{DAQ\PYGZus{}Range} \PYG{o}{=} \PYG{l+m+mi}{100}\PYG{p}{,}\PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{n}{\PYGZus{}} \PYG{p}{;} \end{Verbatim} \end{description} \subsection{Global attributes} \label{netcdf_file:global-attributes}\begin{description} \item[{Measurement\_ID}] \leavevmode This mandatory global attribute defines the measurement ID corresponding to the actual lidar measurement. It is a string composed by 12 characters. The first 8 characters give the start date of measurement in the format YYYYMMDD. The next 2 characters give the Earlinet call-sign of the station. The last 2 characters are used to distinguish between different time-series within the same date. In our example we have to set: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Measurement\PYGZus{}ID}\PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{20090130cc00}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \item[{RawData\_Start\_Date}] \leavevmode This mandatory global attribute defines the start date of lidar measurements in the format YYYYMMDD. In our case we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{RawData\PYGZus{}Start\PYGZus{}Date} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{20090130}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \item[{RawData\_Start\_Time\_UT}] \leavevmode This mandatory global attribute defines the UT start time of lidar measurements in the format HHMMSS. In our case we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{RawData\PYGZus{}Start\PYGZus{}Time\PYGZus{}UT} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{000001}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \item[{RawData\_Stop\_Time\_UT{}`{}`}] \leavevmode This mandatory global attribute defines the UT stop time of lidar measurements in the format HHMMSS. In our case we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{RawData\PYGZus{}Stop\PYGZus{}Time\PYGZus{}UT} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{000501}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \item[{RawBck\_Start\_Date}] \leavevmode This optional global attribute defines the start date of dark measurements in the format YYYYMMDD. In our case we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{RawBck\PYGZus{}Start\PYGZus{}Date} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{20090129}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \item[{RawBck\_Start\_Time\_UT}] \leavevmode This optional global attribute defines the UT start time of dark measurements in the format HHMMSS. In our case we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{RawBck\PYGZus{}Start\PYGZus{}Time\PYGZus{}UT} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{235001}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \item[{RawBck\_Stop\_Time\_UT}] \leavevmode This optional global attribute defines the UT stop time of dark measurements in the format HHMMSS. In our case we have: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{RawBck\PYGZus{}Stop\PYGZus{}Time\PYGZus{}UT} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{235301}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \end{description} \section{Example of file (CDL format)} \label{netcdf_file:example-of-file-cdl-format} To summarize we have the following NetCDF Raw Lidar Data file (in CDL format): \begin{Verbatim}[commandchars=\\\{\}] dimensions: points = 5000 ; channels = 4 ; time = UNLIMITED ; // (10 currently) nb\_of\_time\_scales = 2 ; scan\_angles = 1 ; time\_bck = 6 ; variables: int channel\_ID(channels) ; int Laser\_Repetition\_Rate(channels) ; double Laser\_Pointing\_Angle(scan\_angles) ; int ID\_Range(channels) ; int Scattering\_Mechanism(channels) ; double Emitted\_Wavelength(channels) ; double Detected\_Wavelength(channels) ; double Raw\_Data\_Range\_Resolution(channels) ; int Background\_Mode(channels) ; double Background\_Low(channels) ; double Background\_High(channels) ; int Molecular\_Calc ; double Pressure\_at\_Lidar\_Station ; double Temperature\_at\_Lidar\_Station ; int id\_timescale(channels) ; double Dead\_Time(channels) ; int Dead\_Time\_Corr\_Type(channels) ; int Acquisition\_Mode(channels) ; double Trigger\_Delay(channels) ; int LR\_Input(channels) ; int Laser\_Pointing\_Angle\_of\_Profiles(time, nb\_of\_time\_scales) ; int Raw\_Data\_Start\_Time(time, nb\_of\_time\_scales) ; int Raw\_Data\_Stop\_Time(time, nb\_of\_time\_scales) ; int Raw\_Bck\_Start\_Time(time\_bck, nb\_of\_time\_scales) ; int Raw\_Bck\_Stop\_Time(time\_bck, nb\_of\_time\_scales) ; int Laser\_Shots(time, channels) ; double Raw\_Lidar\_Data(time, channels, points) ; double Background\_Profile(time\_bck, channels, points) ; double DAQ\_Range(channels) ; // global attributes: :Measurement\_ID = "20090130cc00" ; :RawData\_Start\_Date = "20090130" ; :RawData\_Start\_Time\_UT = "000001" ; :RawData\_Stop\_Time\_UT = "000501" ; :RawBck\_Start\_Date = "20090129" ; :RawBck\_Start\_Time\_UT = "235001" ; :RawBck\_Stop\_Time\_UT = "235301" ; data: channel\_ID = 7, 5, 6, 8 ; Laser\_Repetition\_Rate = 50, 50, 50, 50 ; Laser\_Pointing\_Angle = 5 ; ID\_Range = 1, 1, 1, 1 ; Scattering\_Mechanism = 0, 2, 3, 1 ; Emitted\_Wavelength = 1064, 532, 532, 532 ; Detected\_Wavelength = 1064, 532, 532, 607 ; Raw\_Data\_Range\_Resolution = 7.5, 15, 15, 15 ; Background\_Mode = 0, 1, 1, 1 ; Background\_Low = 0, 30000, 30000, 30000 ; Background\_High = 500, 50000, 50000, 50000 ; Molecular\_Calc = 0 ; Pressure\_at\_Lidar\_Station = 1010 ; Temperature\_at\_Lidar\_Station = 19.8 ; id\_timescale = 1, 0, 0, 0 ; Dead\_Time = \_, 10, 10, 10 ; Dead\_Time\_Corr\_Type = \_, 0, 0, 0 ; Acquisition\_Mode = 0, 1, 1, 1 ; Trigger\_Delay = 50, 0, 0, 0 ; LR\_Input = 1,\_,\_,\_ ; DAQ\_Range = 100,\_,\_,\_ ; Laser\_Pointing\_Angle\_of\_Profiles = 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \_, 0, \_, 0, \_, 0, \_, 0, \_, 0 ; Raw\_Data\_Start\_Time = 0, 0, 60, 30, 120, 60, 180, 90, 240, 120, \_, 150, \_, 180, \_, 210, \_, 240, \_, 270 ; Raw\_Data\_Stop\_Time = 60, 30, 120, 60, 180, 90, 240, 120, 300, 150, \_, 180, \_, 210, \_, 240, \_, 270, \_, 300 ; Raw\_Bck\_Start\_Time = 0, 0, 60, 30, 120, 60, \_, 90, \_, 120, \_, 150; Raw\_Bck\_Stop\_Time = 60, 30, 120, 60, 180, 90, \_, 120, \_, 150, \_, 180 ; Laser\_Shots = 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_ ; Raw\_Lidar\_Data = ... Background\_Profile = ... \end{Verbatim} Please keep in mind that in case you submit a file like the previous one all the parameters present in it will be used by the SCC even if you have different values for the same parameters within the SCC\_DB. If you want to use the values already stored in SCC\_DB (this should be the usual way to use SCC) the Raw Lidar Data input file has to be modified as follows: \begin{Verbatim}[commandchars=\\\{\}] dimensions: points = 5000 ; channels = 4 ; time = UNLIMITED ; // (10 currently) nb\_of\_time\_scales = 2 ; scan\_angles = 1 ; time\_bck = 6 ; variables: int channel\_ID(channels) ; double Laser\_Pointing\_Angle(scan\_angles) ; double Background\_Low(channels) ; double Background\_High(channels) ; int Molecular\_Calc ; double Pressure\_at\_Lidar\_Station ; double Temperature\_at\_Lidar\_Station ; int id\_timescale(channels) ; int Laser\_Pointing\_Angle\_of\_Profiles(time, nb\_of\_time\_scales) ; int Raw\_Data\_Start\_Time(time, nb\_of\_time\_scales) ; int Raw\_Data\_Stop\_Time(time, nb\_of\_time\_scales) ; int Raw\_Bck\_Start\_Time(time\_bck, nb\_of\_time\_scales) ; int Raw\_Bck\_Stop\_Time(time\_bck, nb\_of\_time\_scales) ; int LR\_Input(channels) ; int Laser\_Shots(time, channels) ; double Raw\_Lidar\_Data(time, channels, points) ; double Background\_Profile(time\_bck, channels, points) ; double DAQ\_Range(channels) ; // global attributes: :Measurement\_ID = "20090130cc00" ; :RawData\_Start\_Date = "20090130" ; :RawData\_Start\_Time\_UT = "000001" ; :RawData\_Stop\_Time\_UT = "000501" ; :RawBck\_Start\_Date = "20090129" ; :RawBck\_Start\_Time\_UT = "235001" ; :RawBck\_Stop\_Time\_UT = "235301" ; data: channel\_ID = 7, 5, 6, 8 ; Laser\_Pointing\_Angle = 5 ; Background\_Low = 0, 30000, 30000, 30000 ; Background\_High = 500, 50000, 50000, 50000 ; Molecular\_Calc = 0 ; Pressure\_at\_Lidar\_Station = 1010 ; Temperature\_at\_Lidar\_Station = 19.8 ; id\_timescale = 1, 0, 0, 0 ; LR\_Input = 1,\_,\_,\_ ; DAQ\_Range = 100,\_,\_,\_ ; Laser\_Pointing\_Angle\_of\_Profiles = 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \_, 0, \_, 0, \_, 0, \_, 0, \_, 0 ; Raw\_Data\_Start\_Time = 0, 0, 60, 30, 120, 60, 180, 90, 240, 120, \_, 150, \_, 180, \_, 210, \_, 240, \_, 270 ; Raw\_Data\_Stop\_Time = 60, 30, 120, 60, 180, 90, 240, 120, 300, 150, \_, 180, \_, 210, \_, 240, \_, 270, \_, 300 ; Raw\_Bck\_Start\_Time = 0, 0, 60, 30, 120, 60, \_, 90, \_, 120, \_, 150; Raw\_Bck\_Stop\_Time = 60, 30, 120, 60, 180, 90, \_, 120, \_, 150, \_, 180 ; Laser\_Shots = 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, 3000, 3000, 3000, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_, 1500, \_, \_, \_ ; Raw\_Lidar\_Data = ... Background\_Profile = ... \end{Verbatim} This example file contains the minimum collection of mandatory information that has to be found within the Raw Lidar Data input file. If it is really necessary, the user can decide to add to these mandatory parameters any number of additional parameters considered in the previous example. Finally, suppose we want to make the following changes with respect to the previous example: \begin{enumerate} \item {} use a sounding file for molecular density calculation instead of “US Standar Atmosphere 1976” \item {} supply a lidar ratio profile to use in elastic backscatter retrieval instead of a fixed value \item {} provide a overlap function for overlap correction \end{enumerate} In this case we have to generate the following NetCDF additional files: \begin{description} \item[{rs\_20090130cc00.nc}] \leavevmode The name of Sounding Data file has to be computed as follows: \code{"rs\_"{}`{}`+{}`{}`Measurement\_ID} The structure of this file is summarized in table tab:sounding. \item[{ov\_20090130cc00.nc}] \leavevmode The name of Overlap file has to be computed as follows: \code{"ov\_"{}`{}`+{}`{}`Measurement\_ID} The structure of this file is summarized in table tab:overlap. \item[{lr\_20090130cc00.nc}] \leavevmode The name of Lidar Ratio file has to be computed as follows: \code{"lr\_"{}`{}`+{}`{}`Measurement\_ID} The structure of this file is summarized in table tab:lr. \end{description} Moreover we need to apply the following changes to the Raw Lidar Data input file: \begin{enumerate} \item {} Change the value of the variable \code{Molecular\_Calc} as follows: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Molecular\PYGZus{}Calc} \PYG{o}{=} \PYG{l+m+mi}{1} \PYG{p}{;} \end{Verbatim} Of course the variables \code{Pressure\_at\_Lidar\_Station} and \code{Temperature\_at\_Lidar\_Station} are not necessary anymore. \item {} Change the values of the array \code{LR\_Input} as follows: \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{LR\PYGZus{}Input} \PYG{o}{=} \PYG{l+m+mi}{0}\PYG{p}{,}\PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{n}{\PYGZus{}}\PYG{p}{,}\PYG{n}{\PYGZus{}} \PYG{p}{;} \end{Verbatim} \item {} Add the global attribute \code{Sounding\_File\_Name} \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Sounding\PYGZus{}File\PYGZus{}Name} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{rs\PYGZus{}20090130cc00.nc}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \end{enumerate} \begin{enumerate} \setcounter{enumi}{4} \item {} Add the global attribute \code{LR\_File\_Name} \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{LR\PYGZus{}File\PYGZus{}Name} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{lr\PYGZus{}20090130cc00.nc}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \item {} Add the global attribute \code{Overlap\_File\_Name} \begin{Verbatim}[commandchars=\\\{\}] \PYG{n}{Overlap\PYGZus{}File\PYGZus{}Name} \PYG{o}{=} \PYG{l+s}{"}\PYG{l+s}{ov\PYGZus{}20090130cc00.nc}\PYG{l+s}{"} \PYG{p}{;} \end{Verbatim} \end{enumerate} \chapter{User management} \label{user_management:user-management}\label{user_management::doc}\label{user_management:id1} \section{Acount types} \label{user_management:acount-types} \section{Requesting a new account} \label{user_management:requesting-a-new-account} \section{User account security} \label{user_management:user-account-security} \chapter{Indices and tables} \label{index:indices-and-tables}\begin{itemize} \item {} \emph{genindex} \item {} \emph{modindex} \item {} \emph{search} \end{itemize} \renewcommand{\indexname}{Index} \printindex \end{document}