finished SUM update wrt SICE processor

src/main/resources/doc/conf.py

@@ -55,8 +55,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'SEOM S3 for Snow'
-copyright = '2017-2018, Brockmann Consult GmbH'
+project = 'SEOM S3 for Snow / SICE'
+copyright = '2017-2019, Brockmann Consult GmbH'
 author1 = 'Brockmann Consult GmbH'
 s3snow_logo = "pix/s3snow_logo.png"
 
@@ -65,9 +65,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.4'
+version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.4'
+release = '2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -131,7 +131,7 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "SEOM S3 for Snow Software User Manual"
+html_title = "SEOM S3 for Snow / SICE"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -239,7 +239,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'SEOM_S3_SNOW_D2.3_SUM.tex', 'SEOM S3 for Snow - Software User Manual',
+  (master_doc, 'SEOM_S3_SNOW_D2.3_SUM.tex', 'SEOM S3 for Snow / SICE',
    r'Brockmann Consult GmbH', 'howto'),
 ]
 

src/main/resources/doc/mystyle.sty

@@ -32,6 +32,7 @@
       %\end{tabular}}\par
       \begin{tabular}[t]{c}
         % hardcoded here - TODO: learn how to configure this via conf.py
+        \textbf{{Software User Manual}} \\[2.0cm]
         \textbf{{O. Danne, C. Brockmann, A. Kokhanovsky}} \\[0.5cm]
         \textbf{{Brockmann Consult GmbH}} \\
       \end{tabular}}\par

src/main/resources/doc/s3snow_installation.rst

@@ -20,14 +20,8 @@ Usage Requirements
 General Requirements
 --------------------
 
-In general, all S3-SNOW processors require SNAP in the latest snapshot version (v7.0.0-SNAPSHOT), which comes with
-the S3-SNOW software delivery for all platforms (Windows, Linux, MacOS). [#f1]_
-
-.. rubric:: Footnotes
-
-.. [#f1] This snapshot version can be replaced by the next official release (v7.0.0) when available. This will be announced
-         on the SNAP website.
-
+The S3-SNOW and SICE processors require SNAP in the latest release version (v7.0.0), which is available
+for all platforms (Windows, Linux, MacOS) from the SNAP website (step.esa.int).
 
 Operating System
 ----------------
@@ -37,39 +31,26 @@ The S3-SNOW software can be run on any operating system which is suppported by S
 Hardware Requirements
 ---------------------
 
-The S3-SNOW processing system is a complex piece of software. Although the algorithms for the snow properties
+The S3-SNOW / SICE processing system is a complex piece of software. Although the algorithms for the snow properties
 retrieval are mostly relatively simple, the effort for data input/output is fairly high in case of full resolution
 OLCI products.
 Therefore, up-to-date and  sufficiently powerful and
 dimensioned hardware is strongly recommended for reliable and convenient processing.
 
 .. index:: Contents of Software Bundle
 
-Contents of the Processing Software Bundle
-==========================================
+Contents of the S3-SNOW / SICE Processing Software Bundle
+=========================================================
 
-The S3-SNOW processing software consists of the following components:
+The S3-SNOW / SICE processing software consists of the following components:
 
-- *snap-core* module: part of the SNAP installation package
-- *snap-gpf* module:  part of the SNAP installation package
-- *s3tbx-idepix-olci*: nbm plugin file
-- *s3tbx-olci-o2corr*: nbm plugin file
-- *s3tbx-snow*: nbm plugin file
-- *snap-slope*: nbm plugin file
+- *s3tbx-snow-3.0.nbm*: nbm plugin file
+- *snap-slope-1.0.nbm*: nbm plugin file
 - GIMP Digital Elevation Model for Greenland: GeoTIFF auxiliary file
 
-See listing of files in :numref:`sw_bundle`.
-
-.. _sw_bundle:
-.. figure::  pix/sw_bundle.png
-   :align:   center
-   :scale: 80 %
-
-   Contents of the S3-SNOW software bundle.
-
-
-The processor versions were frequently incremented during the iterative development process.
-E.g., the current version of the Snow Properties Processor at S3-Snow project end is v2.1.
+Processors for Rayleigh correction and for IdePix pixel classification are included in the SNAP software. The
+Rayleigh correction processor is installed automatically as part of the SNAP installation, the IdePix processor for
+OLCI needs to be installed from the plugin manager in SNAP Desktop (described in more detail below).
 
 .. index:: How to get the Software
 
@@ -116,7 +97,11 @@ in the SNAP Desktop application. This is illustrated in the figure sequence :num
    :align:   center
    :scale: 80 %
 
-   Selection of plugins to be installed.
+   Selection of plugins to be installed. (Note that the IdePix OLCI plugin is shipped with SNAP and is listed under
+   'Available Plugins', whereas the plugin for S3-SNOW / SICE needs to be accessed through the 'Download' tab from
+   the local disk after download from S3-SNOW ftp site. Also note that the 'IdePix core' plugin needs to be installed
+   in addition to the 'IdePix OLCI'.)
+
 
 .. _add_plugins_confirm:
 .. figure::  pix/add_plugins_confirm.png

src/main/resources/doc/s3snow_processing_system.rst

@@ -50,7 +50,7 @@ The SNAP S3-SNOW processing software consists of the following components and au
 - *SNAP Sentinel-3 toolbox* (current version including latest updates is 7.0.2)
 - *snap-slope* processor  (comes with the SNAP Sentinel-3 toolbox)
 - *s3tbx-olci-o2corr* processor (comes with the SNAP Sentinel-3 toolbox)
-- lookup tables for OLCI O2 correction (come with the SNAP Sentinel-3 toolbox)
+- lookup tables for OLCI O2 harmonisation (come with the SNAP Sentinel-3 toolbox)
 - *s3tbx-snow* plugin (current version is 3.0)
 - *idepix-core* plugin (current version is 7.0.1)
 - *idepix-olci* plugin (current version is 7.0.1)
@@ -59,7 +59,7 @@ The SNAP S3-SNOW processing software consists of the following components and au
 These components are described in more detail in the following subsections.
 Note that, compared to the previous version of this SUM, the software package looks a bit different due to
 the further SNAP evolution during 2019 towards current version 7.0.2.
-I.e., the O2 correction processor (described in more detail later) is now
+I.e., the O2 harmonisation processor (described in more detail later) is now
 an internal part of the Sentinel-3 toolbox, whereas the IdePix pixel classification modules are now
 provided as separate plugins.
 
@@ -152,10 +152,10 @@ The pixel classification with IdePix is an optional processing step in S3-SNOW a
 (although recommended in most cases),
 applied on the same OLCI L1b products which are being considered for the snow properties retrieval.
 
-The OLCI O2 Correction Processor
+The OLCI O2 Harmonisation Processor
 --------------------------------
 
-The OLCI O2 Correction Processor provides a 'harmonisation' of O2 wavebands, which means a modification of the effective
+The OLCI O2 harmonisation Processor provides a 'harmonisation' of O2 wavebands, which means a modification of the effective
 transmittances in O2A wavebands 13, 14 and 15 to their values which would be measured at their mean wavelengths and with
 nominal bandwidth. The corresponding algorithm was provided by R.Preusker (Spectral Earth, Berlin) and is described
 in detail in [`2 <intro.html#References>`_]. Among various outputs, the processor provides the rectified and desmiled
@@ -179,7 +179,7 @@ The GIMP Digital Elevation Model for Greenland
 
 A Digital Elevation Model for Greenland has been generated within the GIMP project. This product has been post-processed
 by BC and is provided in GeoTIFF format with a resolution of ~90m. As only layer in this product, the DEM altitude
-given in metres is provided. The altitude is e.g. used as input by the OLCI O2 Correction Processor.
+given in metres is provided. The altitude is e.g. used as input by the OLCI O2 Harmonisation Processor.
 The GIMP DEM product is illustrated in :numref:`gimp_dem`.
 
 .. _gimp_dem:
@@ -195,10 +195,10 @@ Using the SNAP Slope Processor, this product can be used as input to derive the
 Lookup Tables
 -------------
 
-Various lookup tables are used for the OLCI O2 correction, which in return is part of the IdePix OLCI
+Various lookup tables are used for the OLCI O2 harmonisation, which in return is part of the IdePix OLCI
 pixel classification, all described in more detail in
 [`2 <intro.html#References>`_]. These lookup tables are not provided separately, but as an internal part of the
-OLCI O2 correction processor plugin.
+OLCI O2 Harmonisation processor.
 
 .. index:: Processing Flow
 
@@ -238,11 +238,11 @@ The colour and arrow schemes in the diagrams have the following meaning:
   using the Rayleigh Correction Processor.
 - **green** : Optional processing, i.e. cloud classification: An OLCI L1b radiances product is used as input product
   for the IdePix Pixel Classification Processor. The IdePix output product can then be used as optional second input
-  product for the SPP or SICE. Internally, IdePix calls the O2 Correction Processor to obtain the
+  product for the SPP or SICE. Internally, IdePix calls the O2 Harmonisation Processor to obtain the
   O2 waveband transmissions being used to generate the improved cloud classification band 'cloud_over_snow'. An optional
-  DEM product can be used as input for the O2 Correction Processor. If no DEM is specified by the user, the altitude band
+  DEM product can be used as input for the O2 Harmonisation Processor. If no DEM is specified by the user, the altitude band
   from the Olci L1b product is used.
-- **grey** : Additional processing options, not directly used in the snow properties retrieval. I.e., O2 correction
+- **grey** : Additional processing options, not directly used in the snow properties retrieval. I.e., O2 harmonisation
   and slope/aspect computation, as outlined above.
 - **solid arrows** : indicate input/output to/from a processing module
 - **dashed arrows** : indicate internal calls of one processing module into another

src/main/resources/doc/s3snow_products.rst

@@ -304,16 +304,16 @@ The IdePix OLCI classification flag coding is given in Table 3.7.
     +------------+------------------------+-------------------------------------------------------------+
 
 
-O2 Correction Product
----------------------
+O2 Harmonisation Product
+------------------------
 
-The O2 correction step is done as part of the IdePix pixel classification. The results of this step are
+The O2 harmonisation step is done as part of the IdePix pixel classification. The results of this step are
 used by IdePix internally, and no separate products are written in the S3-SNOW processing flow. However, as the
-O2 correction is also available as a standalone SNAP plugin with a separate target product, its default
+O2 harmonisation is also available as a standalone SNAP plugin with a separate target product, its default
 contents are listed in Table 3.8 for completeness.
 
 .. _o2corr_bands:
-.. table:: Bands in O2 Correction target product
+.. table:: Bands in O2 Harmonisation target product
 
     +-------------------------+---------------------+------------+-------------------------------------------------+
     |     **Name in product** |       **Unit**      |   **Type** |        **Description**                          |