Merge branch 'enhancement/update_installation_procedure' into 'main'

Enhancement/update installation procedure

See merge request !85

HISTORY.rst

@@ -2,10 +2,12 @@
 History
 =======
 
-0.19.2 (coming soon)
---------------------
+0.19.2 (2023-03-22)
+-------------------
 
 * !78 / !84: Updated tutorial in the documentation.
+* !85: Updated installation instructions and environment files
+  since acwater is now directly included into the enpt conda-forge releases.
 
 
 0.19.1 (2023-03-01)

docs/installation.rst

@@ -20,7 +20,8 @@ This is the preferred way to install EnPT. It is the fastest one and it always i
 recent stable release and automatically resolves all the dependencies.
 
 1. Install Mambaforge_.
-2. Install enpt into a separate environment and activate it:
+2. Open a Mambaforge command line prompt and proceed there (e.g., on Windows you can find it in the start menu).
+3. Install enpt into a separate environment and activate it:
 
    .. code-block:: bash
 
@@ -80,19 +81,19 @@ you through the process.
 
 
 
-Optional: Install ACwater for advanced atmospheric correction over water surfaces
+Optional: Install Polymer for advanced atmospheric correction over water surfaces
 ---------------------------------------------------------------------------------
 
 For atmospheric correction of water surfaces using the Polymer algorithm instead of SICOR_ (which is mainly
-designed for land surfaces), the additional packages ACwater_ (a Polymer wrapper developed by AWI Bremerhaven)
-and polymer_ are required.
+designed for land surfaces), the additional package polymer_ is required. The Polymer atmospheric correction is made
+available in EnPT by the ACwater_ package, a wrapper developed by AWI Bremerhaven, which is already contained in the
+default EnPT installation.
 
-1. Using a previously created enpt conda_ environment (as described above), first install some dependencies:
+1. To install the optional package polymer_, first activate the previously created enpt conda_ environment:
 
    .. code-block:: bash
 
     $ mamba activate enpt
-    $ mamba install -c conda-forge cdsapi cython ecmwf-api-client gdal netcdf4 pygrib pyhdf xarray
 
 2. Then register at the `HYGEOS support forum`_, download polymer_ from there, unpack it and
    run the following commands from the unpacked root directory of polymer_:
@@ -104,12 +105,6 @@ and polymer_ are required.
     $ make ancillary
     $ pip install -e .
 
-3. Finally install ACwater:
-
-   .. code-block:: bash
-
-    $ pip install acwater>=0.3.0
-
   .. note::
 
     When using a conda_ environment on Linux or Mac OSX, the needed compilers to build polymer_
@@ -119,8 +114,9 @@ and polymer_ are required.
     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 in the `ACwater Polymer installation instructions`_.
+Apart from that, you need to register at the `CDS registration page`_ and install a `CDS API key`_. This is required
+to automatically download atmospheric AUX data at runtime, which are needed to run Polymer. Further details are
+given in the `ACwater Polymer installation instructions`_.
 
 
 Installing EnPT along with QGIS and the EnMAP-Box (backend + GUI)
@@ -148,7 +144,7 @@ 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.
+requirement polymer_ into the enpt_full environment as described above.
 
 
 .. hint::

requirements.txt

+acwater>=0.3.0
 arosics>=1.0.0
 cerberus
 geoarray>=0.15.8

setup.py

@@ -41,6 +41,7 @@ with open("enpt/version.py", encoding='utf-8') as version_file:
     exec(version_file.read(), version)
 
 req = [
+    'acwater>=0.3.0',
     'arosics>=1.0.0',
     'cerberus',
     'geoarray>=0.15.8',

tests/gitlab_CI_docker/context/environment_enpt.yml

@@ -6,6 +6,7 @@ channels: &id1
 dependencies:
   - python>=3.8
   - pip  # avoids that conda uses the wrong pip
+  - acwater>=0.3.0
   - arosics>1.0.0
   - geoarray>=0.15.8
   - lxml
@@ -18,15 +19,6 @@ dependencies:
   - sensormapgeo>=0.4.0
   - sicor>=0.16.0
 
-  # Polymer AC additional conda requirements
-  - cdsapi
-  - cython
-  - gdal
-  - netcdf4
-  - pygrib
-  - pyhdf
-  - xarray
-
   - pip:
     - cerberus
     - mvgavg
@@ -38,9 +30,6 @@ dependencies:
     - tqdm
     - utm
 
-    # Polymer AC additional pip requirements
-    - acwater>=0.3.0
-
     # test/doc/lint requirements
     - flake8
     - pycodestyle

tests/gitlab_CI_docker/context/environment_enpt_full.yml

@@ -8,15 +8,6 @@ dependencies:
   - pip  # avoids that conda uses the wrong pip
   - enpt
 
-  # Polymer AC additional conda requirements
-  - cdsapi
-  - cython
-  - gdal
-  - netcdf4
-  - pygrib
-  - pyhdf
-  - xarray
-
   # EnMAP-Box
   - astropy
   - catboost
@@ -33,8 +24,5 @@ dependencies:
   - xgboost
 
   - pip:
-    # Polymer AC additional pip requirements
-    - acwater>=0.3.0
-
     # EnMAP-Box
     - enpt_enmapboxapp

tests/gitlab_CI_docker/context/environment_enpt_full_dev.yml

@@ -8,15 +8,6 @@ dependencies:
   - pip  # avoids that conda uses the wrong pip
   - enpt
 
-  # Polymer AC additional conda requirements
-  - cdsapi
-  - cython
-  - gdal
-  - netcdf4
-  - pygrib
-  - pyhdf
-  - xarray
-
   # EnMAP-Box
   - astropy
   - catboost
@@ -33,9 +24,6 @@ dependencies:
   - xgboost
 
   - pip:
-    # Polymer AC additional pip requirements
-    - acwater>=0.3.0
-
     # EnMAP-Box
     - enpt_enmapboxapp
 

tests/gitlab_CI_docker/context/environment_enpt_polymer.yml

-name: enpt_polymer
-
-channels: &id1
-  - conda-forge
-
-dependencies:
-  - python=3.*.*
-  - pip  # avoids that conda uses the wrong pip
-  - enpt
-
-  - cdsapi
-  - cython
-  - gdal
-  - netcdf4
-  - numpy
-  - pandas
-  - pygrib
-  - pyhdf
-  - scipy
-  - xarray
-
-  - pip:
-      - acwater>=0.3.0
-      - ecmwf-api-client