diff --git a/docs/source/components/lower-level/index.rst b/docs/source/components/lower-level/index.rst index 26f9d189..d926a595 100755 --- a/docs/source/components/lower-level/index.rst +++ b/docs/source/components/lower-level/index.rst @@ -21,8 +21,6 @@ Lower Level + +-------------------------+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | :ref:`level2-bulk` | 2 | Level 2 processing of image archives | + +-------------------------+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | :ref:`level2-wrapper` | 2 | Wrapper for Level 2 processing of single image (bridge between archive and single image processing) | -+ +-------------------------+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | :ref:`level2-core` | 2 | Level 2 processing of single image | +--------+-------------------------+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | WVDB | The FORCE :ref:`wvdb` component can be used to generate and maintain a water vapor database used for atmospheric correction of Landsat data | diff --git a/docs/source/components/lower-level/level2/index.rst b/docs/source/components/lower-level/level2/index.rst index 513488c0..d082f972 100755 --- a/docs/source/components/lower-level/level2/index.rst +++ b/docs/source/components/lower-level/level2/index.rst @@ -27,14 +27,10 @@ The data generated with this module are the main input for the :ref:`hlps` compo **Figure 1.** FORCE Level 2 Processing System (L2PS) workflow. -FORCE L2PS consists of two main executables, and a wrapper script that acts as a bridge between them. -For the majority of users, it is recommended to use :ref:`level2-bulk`. -However, for specific purposes (e.g. testing/debugging, or if you want/need to implement your own job scheduler), the expert user may want to use :ref:`force-core` or :ref:`force-wrapper` directly. +FORCE L2PS consists of two main executables: - -+--------------------+-----------------------+--------------------+ -+ :ref:`level2-bulk` + :ref:`level2-wrapper` + :ref:`level2-core` + -+--------------------+-----------------------+--------------------+ +- for the majority of users, it is recommended to use :ref:`level2-bulk`. +- some expert users may want to use :ref:`force-core` directly. **A glimpse of what you get:** @@ -48,7 +44,6 @@ However, for specific purposes (e.g. testing/debugging, or if you want/need to i :maxdepth: 2 level2.rst - l2ps_.rst l2ps.rst param.rst format.rst diff --git a/docs/source/components/lower-level/level2/l2ps.rst b/docs/source/components/lower-level/level2/l2ps.rst index 2069fa02..b2768e22 100755 --- a/docs/source/components/lower-level/level2/l2ps.rst +++ b/docs/source/components/lower-level/level2/l2ps.rst @@ -3,10 +3,10 @@ force-l2ps ========== -The hidden workhorse of FORCE L2PS is force-l2ps, which is a lower-level routine called from within :ref:`level2-bulk` and :ref:`level2-wrapper`. +The hidden workhorse of FORCE L2PS is ``force-l2ps``, which is a lower-level routine called from within :ref:`level2-bulk`. It processes one single image. -For the majority of users, it is recommended to use force-level2 instead of directly calling force-l2ps. +For the majority of users, it is recommended to use force-level2 instead of directly calling ``force-l2ps``. However, for specific purposes (e.g. testing/debugging or or if you need/want to implement your own job scheduler), the expert user may want to use this program directly. Usage @@ -21,8 +21,8 @@ Usage * image-dir | The 1st argument is the directory that contains the image data. - | In case of Landsat, the *.tar.gz archive needs to be extracted before processing. - | In case of Sentinel-2, the *.zip archive needs to extracted before processing and either the ``.SAFE`` directory or one tile (directory) within the ``GRANULE`` directory must be given as input. + | In case of Landsat, the ``*.tar.gz`` archive needs to be extracted before processing. + | In case of Sentinel-2, the ``*.zip`` archive needs to extracted before processing and either the ``.SAFE`` directory or one tile (directory) within the ``GRANULE`` directory must be given as input. * parameter-file diff --git a/docs/source/components/lower-level/level2/l2ps_.rst b/docs/source/components/lower-level/level2/l2ps_.rst deleted file mode 100755 index f46cde24..00000000 --- a/docs/source/components/lower-level/level2/l2ps_.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _level2-wrapper: - -force-l2ps\_ -============ - -This program is a wrapper script that acts as a bridge between :ref:`level2-bulk` and :ref:`level2-core`. -It is called from within :ref:`level2-bulk` for each image. - -For the majority of users, it is recommended to use force-level2 instead of directly calling force-l2ps_. - -If necessary, this tool unpacks the Level 1 zip/tar.gz containers. -It calls :ref:`level2-core` to process the umpacked images. -If input data were unpacked by this tool, it removes the temporary data after processing. -The tool also redirects the messages printed by :ref:`level2-core` to logfiles. - - -Usage -^^^^^ - -.. code-block:: bash - - force-l2ps_ - - Usage: force-l2ps_ image parfile bindir logdir tempdir timeout_zip - -* image - - | The 1st argument is the input image. - | In case of Landsat, it can be the ``.tar.gz`` archive, or the unpacked image. - | In case of Sentinel-2, it can be the ``.zip`` archive, the unpacked ``.SAFE`` directory, or one tile (directory) within the ``GRANULE`` directory must be given as input. - -* parfile - - | The :ref:`l2-param` needs to be given as second argument - -* bindir - - | This is the directory, where :ref:`level2-core` is installed - -* logdir - - | This is the directory, where logfiles should be stored. - -* tempdir - - | This is the directory for temporarily unpacking the ``.zip`` or ``.tar.gz`` containers - -* timeout_zip - - | This is a timeout in seconds after which the unpacking of the ``.zip`` or ``.tar.gz`` containers will be cancelled - diff --git a/docs/source/components/lower-level/level2/level2.rst b/docs/source/components/lower-level/level2/level2.rst index 2828c7b9..97f301bf 100755 --- a/docs/source/components/lower-level/level2/level2.rst +++ b/docs/source/components/lower-level/level2/level2.rst @@ -41,14 +41,14 @@ It spawns jobs by using multiple ssh logins; the number of allowed ssh logins pe With a small change in the script and passwordless access to other machines, GNU parallel also allows for parallelization across a cluster. It is highly advised to monitor the workload. -Swapping should be prevented – in this case, decrease the number of parallel jobs. +Swapping should be prevented - in this case, decrease the number of parallel jobs. The number of CPUs can be re-adjusted while(!) force-level2 is running. -A file ‘cpu-$TIME’ is created in the temporary directory. +A file ``cpu-$TIME`` is created in the temporary directory. This file can be modified. Note that the effect is not immediate, as the load is only adjusted after one of the running jobs (images) is finished. To prevent an I/O jam at startup (by reading / extracting a lot of data simultaneously), a delay (in seconds) might be necessary. GNU parallel will wait that long before starting a new job. -The necessary delay (or none) is dependent on your system’s architecture (I/O speed etc), on sensor to be processed, and whether packed archives or uncompressed images are given as input. +The necessary delay (or none) is dependent on your system's architecture (I/O speed etc), on sensor to be processed, and whether packed archives or uncompressed images are given as input.