TNO Intern

Commit fe6c0d2a authored by Arjo Segers's avatar Arjo Segers
Browse files

Updated documentation.

parent acd47b00

doc/source/s5p-no2.rst

+2 −1
Original line number Diff line number Diff line
@@ -496,7 +496,8 @@ and the time range of pixels in the file:: 
This file will be used by the observation operator to selects orbits with pixels valid for 

a desired time range.



In the settings, define the name of the file to be created::

A listing file is for example created using the :py:class:`.CSO_S5p_Listing` class.

In the settings passed to the class, define the name of the file to be created::



    ! csv file that will hold records per file with:

    ! - timerange of pixels in file

py/cso.py

+33 −8
Original line number Diff line number Diff line
@@ -31,21 +31,20 @@ Actual implementations can be found in submodules: 
.. toctree::

   :maxdepth: 1



   pymod-cso_file

   pymod-cso_inquire

   pymod-cso_scihub

   pymod-cso_pal

   pymod-cso_s5p

   pymod-cso_s5p_superobs

   pymod-cso_file

   pymod-cso_gridded

   pymod-cso_superobs

   pymod-cso_regions

   pymod-cso_mapping

   pymod-cso_colocate

   pymod-cso_regions

   pymod-cso_superobs

   pymod-cso_catalogue

   pymod-cso_plot

   pymod-cso_regions

   pymod-cso_constants

   pymod-cso_mapping





.. Label, use :ref:`text <label>` for reference
@@ -60,21 +59,47 @@ and are defined according to the following hierchy: 


* :py:class:`.UtopyaRc`



  * :py:class:`.CSO_Inquire_Plot`

  * :py:class:`.CSO_SciHub_Inquire`

  * :py:class:`.CSO_PAL_Inquire`

  * :py:class:`.CSO_Inquire_Plot`

  * :py:class:`.CSO_S5p_Convert`

  * :py:class:`.CSO_S5p_Listing`

  * :py:class:`.CSO_GriddedAverage`

  * :py:class:`.CSO_GriddedAverageMeans`

  * :py:class:`.CSO_CoLocate`

  * :py:class:`.CSO_CoLocatePlotTimeSeries`

  * :py:class:`.CSO_SuperObs`

  * :py:class:`.CSO_CreateCountryMask`

  * :py:class:`.CSO_Catalogue`



    * :py:class:`.CSO_Catalogue`

    * :py:class:`.CSO_SimCatalogue`

    * :py:class:`.CSO_GriddedCatalogue`



  * :py:class:`.CSO_CreateCountryMask`

  * :py:class:`.CSO_CatalogueBase`



      * :py:class:`.CSO_Catalogue_RegionsMaps`

      * :py:class:`.CSO_Catalogue_RegionsTimeSeries`



  * :py:class:`.CSO_Statistics_RegionsTables`



* :py:class:`.S5p_File`

* :py:class:`.CSO_File`



  * :py:class:`.CSO_S5p_File`



* :py:class:`.CSO_Listing`

* :py:class:`.S5p_File`

* :py:class:`.CreateCountryMap`

* :py:class:`.RegionMap`



* :py:class:`.Figure`

 

  * :py:class:`.MapFigure`

   

  * :py:class:`.ColorbarFigure`

    

    * :py:class:`.ColorbarMapFigure`



"""
@@ -83,7 +108,6 @@ and are defined according to the following hierchy: 
#-------------------------------------------------



from cso_file         import *

from cso_catalogue    import *

from cso_inquire      import *

from cso_scihub       import *

from cso_pal          import *
@@ -96,6 +120,7 @@ from cso_regions import * 
from cso_constants    import *

from cso_mapping      import *

from cso_plot         import *

from cso_catalogue    import *





#-------------------------------------------------

py/cso_plot.py

+5 −4
Original line number Diff line number Diff line
@@ -27,13 +27,14 @@ Plotting tools. 
Class hierchy

=============



* Figure

* :py:class:`.Figure`

 

  * MapFigure

  * :py:class:`.MapFigure`

   

  * ColorbarFigure

  * :py:class:`.ColorbarFigure`

    

    * :py:class:`.ColorbarMapFigure`



    * ColorbarMapFigure





Classes and methods