changeset
First part of the tutorial.
Fri, 30 Mar 2012 18:15:44 +0200
- author
- ulalume3 <binietoglou@imaa.cnr.it>
- date
- Fri, 30 Mar 2012 18:15:44 +0200
- changeset 7
- 682b4aa84276
- parent 6
- 35531ef36bab
- child 8
- b528a98fdb3f
First part of the tutorial.
--- a/details/adding_channels.rst Fri Mar 30 18:15:23 2012 +0200 +++ b/details/adding_channels.rst Fri Mar 30 18:15:44 2012 +0200 @@ -1,2 +1,10 @@ Adding channels =============== + + + +.. _signal-types: + +Signal types +~~~~~~~~~~~~ +(explain here all the signal type abreviations).
--- a/details/adding_station.rst Fri Mar 30 18:15:23 2012 +0200 +++ b/details/adding_station.rst Fri Mar 30 18:15:44 2012 +0200 @@ -1,2 +1,14 @@ Adding stations =============== + + + +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 :ref:`add_new_system` section. +You can add more stations by clicking on the "Add another Hoi System" option. + +.. note:: + + You need to have *Javascript* enebled to add a new station from this page. + +
--- a/details/adding_system.rst Fri Mar 30 18:15:23 2012 +0200 +++ b/details/adding_system.rst Fri Mar 30 18:15:44 2012 +0200 @@ -1,2 +1,4 @@ +.. _add_new_system: + Adding systems ==============
--- a/tutorial.rst Fri Mar 30 18:15:23 2012 +0200 +++ b/tutorial.rst Fri Mar 30 18:15:44 2012 +0200 @@ -6,14 +6,13 @@ Tutorial ======== -Contents: - .. toctree:: :maxdepth: 2 tutorial/introduction tutorial/adding_station tutorial/adding_system + tutorial/adding_telescopelaser tutorial/adding_channels tutorial/adding_products tutorial/processing_data
--- a/tutorial/adding_channels.rst Fri Mar 30 18:15:23 2012 +0200 +++ b/tutorial/adding_channels.rst Fri Mar 30 18:15:44 2012 +0200 @@ -1,4 +1,86 @@ -Adding channels +Adding a channel =============== -Walk-through of 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 **HOI channels** in the *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 **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 **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. + +.. 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 :ref:`last section <connect-channel-to-system>`) to avoid any problems. + + +Fill in the fields +------------------ + +To start using the single calculus chain you will need to fill the following fields: + +Name + The name of the channel ex. "355", "1064 analog" etc. + +Telescope + The telescope that is used for this channel + +Laser + The laser that is used for this channel + +Interference filter center + The center of the interference filter in nm + +Interference filter FWHM + The FWHM of the interference filter in nm + +Emission wavelength + The emission wavelength of the laser used for this channel + +Field of view + The field of view realated to this channel in mrad + +Raw range resolution + The raw range resolution of the measured data in m + +Dead time + The dead of the detector in ns. You should fill in this in case + of a photon counting detector. + +Trigger delay + The trigger delay value for the channel in ns. Fill in 0 if not needed. + +Scattering mechanism + The scattering mechanism that is involved in this channel. Select the appropriate value from the drop-down list. + +Dead time correction type + The dead time correction type to be applied. Select *Not defined* if none needs to be defined. + +Background mode + The way to calculate the singal background. Select *Not defined* if none needs to be defined. + +Signal type + The type of the singal that is measured, ex. "elT" for total elastic, "vrRN2" for vibrational-rotational + Raman signal from Nitrogen melecules etc. See :ref:`signal-types` for details. + +Detection mode + The detection mode of this channel. + +.. _connect-channel-to-system: + +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 **System channels** area. + +When you are done, press the **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. + +
--- a/tutorial/adding_station.rst Fri Mar 30 18:15:23 2012 +0200 +++ b/tutorial/adding_station.rst Fri Mar 30 18:15:44 2012 +0200 @@ -1,23 +1,33 @@ -Adding stations -=============== +Adding a station +================ -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. +You can change all your settings throught the *admin section* of the website. +To reach it, click on **Station admin** link at the main menu of the site. + +.. note:: + + You will need to have an account with admin access privilages to access this part of the site. + See :ref:`user-management` for details. -Hoi stations ------------- -In the **HOI stations** section you can control the main parameters of the statino you have access to. -From here you can edit the existing station or add a new one. +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 **HOI stations** in the *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. -Adding a new station -~~~~~~~~~~~~~~~~~~~~ -When adding a new station you need to specify the following fields +To add a new station to the database click on **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 **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: Name The name of the station Id - The earlinet call sign with exactrly 2 caracters. + The earlinet call sign with exactly 2 characters. + +Institute name + The name of the institute that own the system Latitude In degrees north is the latitude of the station. @@ -31,35 +41,10 @@ PI The name of the Principal Investigator of the station. -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 :ref:`add_new_system` section. -You can add more stations by clicking on the "Add another Hoi System" option. - -.. note:: - - You need to have *Javascript* enebled to add a new station from this page. - - - -Updating an existing station -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Deleting a station -~~~~~~~~~~~~~~~~~~ +You can leave all the other fields empty. When you are done, press the **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. -System configuration --------------------- - - -.. _add_new_system: +We don't have to make any more changes in this part, so you can click on **Home** +on the top left of the page to return to the starting page of the *admin section*. -Adding a new system configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Updating an existing system -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Deleting a system -~~~~~~~~~~~~~~~~~ - -
--- a/tutorial/adding_system.rst Fri Mar 30 18:15:23 2012 +0200 +++ b/tutorial/adding_system.rst Fri Mar 30 18:15:44 2012 +0200 @@ -1,4 +1,53 @@ -Adding systems +Adding a system =============== -Walk-through of adding a system. +After adding a station to the database, we need to add a new system. +To do this, click on the **HOI systems** in the *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. + +.. note:: + + In the Single Calculus Chain, a *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 *two different* systems in the database, one for each different configuration you use. + + +To add a new system to the database click on **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 **bold** +are mandatory and you will need to fill them before you can save you new system. + +.. 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. + +For now you will need to fill in the following fields: + +Name + The name of your system. + +Station (owner) + From the drop-down list, select the station which this system belongs to. + +Configuration + 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 + +Pi + The principle investigator of this system + +Height asl + The altitude of the system above sea level (in meters). + +You can leave all the other fields empty. When you are done, press the **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 **Home** +on the top left of the page to return to the starting page of the *admin section*. + + + + +
