Commit 21d18085 authored by Daniel Scheffler's avatar Daniel Scheffler
Browse files

Updated installation instructions and GUI screenshots.


Signed-off-by: Daniel Scheffler's avatarDaniel Scheffler <danschef@gfz-potsdam.de>
parent 60d5f78a
Pipeline #24585 passed with stages
in 50 minutes and 25 seconds
......@@ -2,6 +2,12 @@
History
=======
0.18.2 (coming soon)
--------------------
* Updated installation instructions and GUI screenshots.
0.18.1 (2021-06-16)
-------------------
......
.. _installation:
============
Installation
============
EnPT can be installed in two different ways:
- as a standalone package which can be used via the Python API or from the command line
- along with the EnMAP-Box (a QGIS plugin) which provides a GUI for EnPT.
Installing EnPT as a standalone package (backend code only)
***********************************************************
Using Anaconda or Miniconda (recommended)
-----------------------------------------
......@@ -74,10 +82,10 @@ Optional: Install ACwater for advanced atmospheric correction over water surface
---------------------------------------------------------------------------------
For atmospheric correction of water surfaces using the Polymer algorithm instead of SICOR_ (which is mainly
designed for land surfaces), the additional package ACwater_ (a Polymer wrapper developed by AWI Bremerhaven)
is required.
designed for land surfaces), the additional packages ACwater_ (a Polymer wrapper developed by AWI Bremerhaven)
and polymer_ are required.
1. Using a previously created enpt conda environment (as described above), first install some dependencies:
1. Using a previously created enpt conda_ environment (as described above), first install some dependencies:
.. code-block:: bash
......@@ -86,7 +94,26 @@ is required.
$ pip install ecmwf-api-client
2. Then register at the `HYGEOS support forum`_, download polymer_ from there, unpack it and
run :code:`pip install .` from the root directory of Polymer.
run the following commands from the unpacked root directory of polymer_:
.. code-block:: bash
$ make
$ make auxdata_common
$ make ancillary
  • @danschef According to the Polymer makefile, make ancillary only creates the directory ANCILLARY/METEO/, but the automatically downloaded ECMWF data are stored in the directory ANCILLARY/ERA5/. I don't know why the building of the latter isn't part of the make command, but we either have to modify the makefile or create the directory ANCILLARY/ERA5/ manually (as it is described in Brenner's installation documentation).

Please register or sign in to reply
$ pip install -e .
.. note::
When using a conda_ environment on Linux or Mac OSX, the needed compilers to build polymer_
should be already installed. On Windows, you need to install the `Microsoft build tools for visual studio`_
including the C++ build tools, the latest versions of MSVCv142 - VS 2019 C++ x64/x86 build tools and Windows 10 SDK
(see `here <https://wiki.python.org/moin/WindowsCompilers>`__ for details).
However, polymer_ is currently *not Windows compatible* and will likely not run as expected.
Apart from that, you need to register at the `CDS registration page`_ and install a `CDS API key`_.
Further details are given `here <https://gitlab.awi.de/phytooptics/acwater/-/blob/master/docs/installation.rst>`__.
3. Finally install ACwater:
......@@ -98,10 +125,38 @@ is required.
Further details about the installation of ACwater can be found in the `ACwater Polymer installation instructions`_.
Installing EnPT along with QGIS and the EnMAP-Box (backend + GUI)
*****************************************************************
If you want to use EnPT including the GUI_ in the EnMAP-Box_, it is highly recommended to install QGIS_,
the EnMAP-Box_ requirements, the EnPT backend code and the EnPT GUI_ into a single conda_ environment.
To do so, run the following command on a conda_ command line:
.. code-block:: bash
$ conda env create -n enpt_full -f https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT/raw/master/tests/gitlab_CI_docker/context/environment_enpt_full.yml
Then activate the newly created conda_ environment and start QGIS_:
.. code-block:: bash
$ conda activate enpt_full
$ qgis
The EnMAP-Box_ QGIS_ plugin can then be installed via the QGIS_ Plugin manager and the EnPT GUI_ can be started
from within the EnMAP-Box_ as described
`here <https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/enpt_enmapboxapp/doc/usage.html>`__.
If you want to use advanced atmospheric correction over water surfaces, please install the optional
requirement polymer_ as described above.
.. note::
EnPT has been tested with Python 3.6+., i.e., should be fully compatible to all Python versions from 3.6 onwards.
EnPT has been tested with Python 3.6+ on Linux, Windows and Mac OSX.
.. _pip: https://pip.pypa.io
......@@ -110,5 +165,11 @@ Further details about the installation of ACwater can be found in the `ACwater P
.. _ACwater: https://gitlab.awi.de/phytooptics/acwater/
.. _`ACwater Polymer installation instructions`: https://gitlab.awi.de/phytooptics/acwater/-/blob/master/docs/installation.rst
.. _HYGEOS support forum: https://forum.hygeos.com
.. _`polymer`: https://forum.hygeos.com
.. _polymer: https://forum.hygeos.com
.. _SICOR: https://git.gfz-potsdam.de/EnMAP/sicor
.. _GUI: https://gitext.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/enpt_enmapboxapp
.. _EnMAP-Box: https://bitbucket.org/hu-geomatics/enmap-box
.. _QGIS: https://www.qgis.org
.. _CDS registration page: https://cds.climate.copernicus.eu/
.. _CDS API key: https://cds.climate.copernicus.eu/api-how-to
.. _Microsoft build tools for visual studio: https://visualstudio.microsoft.com/de/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16
......@@ -119,7 +119,7 @@ raw format to geometrically and atmospherically corrected bottom-of-atmosphere r
Open the EnPT GUI to run the processing chain. You can find it here:
:menuselection:`QGIS 3.xx --> EnMAP-Box --> Processing Toolbox --> EnMAP-Box --> Pre-Processing --> EnMAP processing tool algorithm`.
.. image:: img/tut__screenshot_enpt_enmapboxapp.png
.. image:: img/screenshot_enpt_enmapboxapp_v0.6.0.png
Select the :file:`ENMAP01-____L1B-DT000000987_20130205T105307Z_001_V000101_20190426T143700Z__rows0-99.zip` downloaded
above at the parameter **L1B EnMAP image** and check that the **Anaconda root directory** points to the correct
......
......@@ -141,7 +141,7 @@ To install it in QGIS, please refer to the separate repository enpt_enmapboxapp_
Here is screenshot of the current version:
.. image:: img/screenshot_enpt_enmapboxapp_1031x876.png
.. image:: img/screenshot_enpt_enmapboxapp_v0.6.0.png
.. _enpt_enmapboxapp: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/enpt_enmapboxapp
.. _enpt/options/options_default.json: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT/blob/master/enpt/options/options_default.json
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment