Installation

The EnMAP-Box is a plugin for QGIS and requires additional python packages that need to be installed independent from QGIS.

../_images/install.png

1. Install QGIS

Install QGIS version 3.10.0 or higher to run the EnMAP-Box. You can get QGIS here. Additional information on the installation process is provided in the QGIS Documentation.

In case you already have QGIS installed, you can skip this step.

Tip

The installation of additional python packages can be cumbersome, in particular on windows and macOS. You might therefore consider to install QGIS in a conda/anaconda environment.



2. Install required python packages

The EnMAP-Box core plugin requires the following python packages:

Follow the platform specific installation instructions below in order to install these packages.

Note

Starting with version 3.6 the EnMAP-Box starts without previously installing the required Python packages. If needed, these can be installed ad-hoc to the user directory using the Package Installer (Project ‣ Package Installer) in order to make the plugin run. However, we still recommend to install the packages as described below!

../_images/package_installer.png

Windows

  1. Close QGIS, if it is open.

  2. Start the OSGeo4W Shell osgeoicon with admin rights.

    • Open the start menu QGIS 3.xx ‣ OSGeo4W Shell ‣ Right-Click ‣ Run as administrator

      ../_images/open_osgeoshell.png

      Hint

      If you used the OSGeo4W Installer to install QGIS, the OSGeo4W Shell will be listed under OSGeo4W in the Start Menu

  3. Activate the Python 3 environment by entering:

    call py3_env.bat
    
    ../_images/shell_callpy3env.png

  1. Install required python packages by entering:

    python3 -m pip install -r https://bitbucket.org/hu-geomatics/enmap-box/raw/develop/requirements.txt
    

    Now all packages will be installed automatically. After completion, the shell should show something like this:

    ../_images/shell_install_output.png

    If the package installation was successful, you can close the shell. The required packages are installed now and you can continue to start/install the EnMAP-Box.


    Error

    In case you run into problems because pip is not available in your python environment (error message C:/.../python3.exe: No module named pip or similar), follow these steps…


Linux

Note

Tested on Ubuntu 18.04

  1. Open the terminal and install all missing packages using pip:

    python3 -m pip install -r https://bitbucket.org/hu-geomatics/enmap-box/raw/develop/requirements.txt
    

    Error

    See FAQ if you run into problems installing the packages.


Mac

  1. Open the terminal and install all missing packages using pip:

    python3 -m pip install -r https://bitbucket.org/hu-geomatics/enmap-box/raw/develop/requirements.txt
    

    Error

    See FAQ if you run into problems installing the packages.


3. Install or update the EnMAP-Box

Install from QGIS plugin repository

  1. Open QGIS and go to Plugins ‣ Manage and Install Plugins ‣ All

  2. In the search bar enter enmap or EnMAP-Box 3

  3. Now the EnMAP-Box should be listed in the plugin list:

    ../_images/pluginmanager_all.PNG

    Select it and click Install plugin (or Upgrade in case you update to a new version)

  4. Start the EnMAP-Box via the icon icon or from the menubar Raster ‣ EnMAP-Box

Install older version

  1. Go to the QGIS Python Plugins Repository https://plugins.qgis.org/plugins/enmapboxplugin/
  2. Click on the Versions tab to see all available version.
  3. Click on the desired version and on the next page click download
  4. It is recommended to uninstall previous EnMAP-Box versions (delete folder manually, or in QGIS via Plugins ‣ Manage and Install Plugins ‣ Installed ‣ EnMAP-Box 3 ‣ Uninstall plugin)
  5. Open Plugins ‣ Manage and Install Plugins ‣ Install from ZIP.
  6. Press and select the downloaded zip file (enmapboxplugin.3.x.YYYYMMDDTHHMM.QGIS3.zip) and click Install plugin.
  7. Start the EnMAP-Box via the icon icon or from the menubar Raster ‣ EnMAP-Box.