Commit 20136389 authored by Daniel Scheffler's avatar Daniel Scheffler
Browse files

Updated HISTORY.rst and version info. Updated GUI screenshots and installation.rst.


Signed-off-by: Daniel Scheffler's avatarDaniel Scheffler <danschef@gfz-potsdam.de>
parent b2668f6c
Pipeline #24518 failed with stage
in 1 minute and 19 seconds
......@@ -2,6 +2,16 @@
History
=======
0.6.0 (2021-06-16)
------------------
* Added parameters related to three new AC modes in EnPT and ACwater.
* Revised descriptions and titles all over the GUI.
* Revised 'optional' flags.
* Improved connection of the QGIS feedback object to EnPT STDOUT and STDERR stream to fix missing log messages on Linux.
* Updated GUI screenshots and installation.rst.
0.5.0 (2021-06-04)
------------------
......
......@@ -29,8 +29,8 @@ See also the latest coverage_ report and the nosetests_ HTML report.
How the GUI looks like
----------------------
.. image:: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/enpt_enmapboxapp/raw/master/docs/images/screenshot_enpt_enmapboxapp_1031x876.png
:width: 1031 px
.. image:: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/enpt_enmapboxapp/raw/master/docs/images/screenshot_enpt_enmapboxapp_v0.6.0.png
:width: 1046 px
:height: 876 px
:scale: 100 %
......
......@@ -8,8 +8,8 @@ QGIS_ plugin to process imaging spectroscopy data and particularly the hyperspec
of QGIS_. It allows to parameterize EnPT_ and run the processing chain to generate EnMAP_ Level-2A from Level-1B data.
.. image:: ./images/screenshot_enpt_enmapboxapp_1031x876.png
:width: 1031 px
.. image:: ./images/screenshot_enpt_enmapboxapp_v0.6.0.png
:width: 1046 px
:height: 876 px
:scale: 100 %
......
enpt\_enmapboxapp package
=========================
Submodules
----------
enpt\_enmapboxapp.enpt\_enmapboxapp module
------------------------------------------
.. automodule:: enpt_enmapboxapp.enpt_enmapboxapp
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: enpt_enmapboxapp
:members:
:undoc-members:
:show-inheritance:
......@@ -4,25 +4,32 @@
Installation
============
Since enpt_enmapboxapp extends the functionality of the EnMAP-Box_, the installation of enpt_enmapboxapp requires
QGIS_ including the EnMAP-Box plugin. If QGIS_ or the EnMAP-Box_ is not yet installed on your system,
Since enpt_enmapboxapp (the EnPT GUI package) extends the functionality of the EnMAP-Box_, the installation of
enpt_enmapboxapp requires QGIS_ including the EnMAP-Box plugin. If QGIS_ or the EnMAP-Box_ is not yet installed on your system,
follow the installation instructions
`here <https://enmap-box.readthedocs.io/en/latest/usr_section/usr_installation.html>`__.
`here <https://enmap-box.readthedocs.io/en/latest/usr_section/usr_installation.html>`__. This should also automatically
install the enpt_enmapboxapp package into the QGIS_ Python environment.
The enpt_enmapboxapp package is then installed into the QGIS_ Python environment:
However, make sure you have the latest version of the GUI installed by running the following command on a command line
with the QGIS Python environment activated:
.. code-block:: console
pip install enpt_enmapboxapp
pip install --upgrade enpt_enmapboxapp
.. note::
On a Windows system, you have to activate the the QGIS environment first. To do so, run the OSGeo4W Shell (listed
under OSGeo4W in the Start Menu) as administrator and enter ``call py3_env.bat``.
To make the enpt_enmapboxapp GUI run together with EnPT_ (backend), EnPT_ has to be installed into a separate Anaconda
environment. Please refer to the EnPT_ installation instructions
`here <https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/doc/installation.html>`__.
On a Windows system and in case your QGIS is NOT installed into a Conda Python environment but via the OSGeo4W
installer, you have to activate the the QGIS environment first. To do so, run the OSGeo4W Shell (listed under
OSGeo4W in the Start Menu) as administrator and enter :code:`call py3_env.bat`.
To make the enpt_enmapboxapp (GUI code) run together with EnPT_ (backend), the EnPT_ backend code has to be installed.
The easiest way (recommended) is to install QGIS, the EnMAP-Box and EnPT into a single Conda environment. Please
refer to the EnPT_ installation instructions
`here <https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/doc/installation.html>`__ to do so. However,
if QGIS is already installed as a standalone-software which does not use a Conda Python environment in the background
(e.g., installed via the OSGeo4W installer on Windows), the EnPT backend code has to be installed into a separate
Conda environment that is called 'enpt' and then linked to the QGIS Python using the EnPT GUI.
.. _EnPT: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT
.. _EnMAP-Box: https://www.enmap.org/data_tools/enmapbox/
......
API Reference
=============
.. toctree::
:maxdepth: 4
enpt_enmapboxapp
......@@ -3,10 +3,10 @@ Usage
=====
The enpt_enmapboxapp GUI can be found in
:menuselection:`QGIS 3.xx --> EnMAP-Box --> Processing Toolbox --> Pre-Processing --> EnMAP processing tool algorithm`
:menuselection:`QGIS 3.xx --> EnMAP-Box --> Processing Toolbox --> Pre-Processing --> EnPT - EnMAP Processing Tool`
.. image:: ./images/sceenshot_how_to_start_1342x1029.png
.. image:: ./images/screenshot_how_to_start.png
:scale: 75 %
Use the GUI to parameterize EnPT_ according to your input dataset and the desired processing settings.
......@@ -15,10 +15,11 @@ The input parameters are explained
.. hint::
Before you start the processing chain, make sure, that the Anaconda root directory is correctly set. It should
If your QGIS is not installed into a Conda Python environment but installed as a standalone software, make sure,
that the Anaconda root directory is correctly set before you start the processing chain. It should
point to the Anaconda installation containing the previously installed `enpt` Python environment.
The status of computation can watched in the log tab and the QGIS Python console.
The status of computation can be watched in the log tab and the QGIS Python console.
.. _EnPT: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT
......@@ -22,6 +22,6 @@
# You should have received a copy of the GNU Lesser General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
__version__ = '0.5.0'
__versionalias__ = '20210604.01'
__version__ = '0.6.0'
__versionalias__ = '20210615.01'
__author__ = 'Daniel Scheffler'
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