Installation¶

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

1. Install QGIS¶

Install QGIS version 3.16 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.

MacOS¶

Before you can install QGIS from the downloaded disk image qgis-macos-pr.dmg, you need to allow your macOS to install it:

Open System Preferences > Security & Privacy an
Unlock the page to make changes.
Enable “Allow apps downloaded from”: “Anywhere”

Now open the disk image (double click) and copy the QGIS.app to your applications folder

usr_section/../img/macos/install_qgis2.pn

2. Install required python packages¶

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

numpy
scipy
scikit-learn
matplotlib
astropy (optional, relevant e.g. for certain filtering algorithms)

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!

Windows¶

Close QGIS, if it is open.
Start the OSGeo4W Shell with admin rights.
- Open the start menu QGIS 3.xx ‣ OSGeo4W Shell ‣ Right-Click ‣ Run as administrator
  
  Hint
  
  If you used the OSGeo4W Installer to install QGIS, the OSGeo4W Shell will be listed under OSGeo4W in the Start Menu
Activate the Python 3 environment by entering:
```
call py3_env.bat
```

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:

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¶

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¶

Most packages required by the EnMAP-Box, like scikit-learn, are already be part of the QGIS.app environment.

Since QGIS 3.16, the packaging mechanism, allows to install additional package with pip as followed:

/Applications/QGIS.app/Contents/MacOS/bin/pip3 install astropy

/Applications/QGIS.app/Contents/MacOS/bin/pip3 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¶

Open QGIS and go to Plugins ‣ Manage and Install Plugins ‣ All
In the search bar enter enmap or EnMAP-Box 3
Now the EnMAP-Box should be listed in the plugin list:

Select it and click Install plugin (or Upgrade in case you update to a new version)
Start the EnMAP-Box via the icon or from the menubar Raster ‣ EnMAP-Box

Experimental version

It is also possible to install the most recent develop version of the EnMAP-Box. To do so, make sure that the option Show also experimental plugins is activated in the plugin manager settings. Once activated, there is an additional button Install Experimental Plugin in the plugin manager.

Warning

As the experimental tag suggests, this version comes with the newest features and developments, but might also be prone to bugs and crashes.

Install older version¶

Go to the QGIS Python Plugins Repository https://plugins.qgis.org/plugins/enmapboxplugin/
Click on the Versions tab to see all available version.
Click on the desired version and on the next page click
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)
Open Plugins ‣ Manage and Install Plugins ‣ Install from ZIP.
Press … and select the downloaded zip file (enmapboxplugin.3.x.YYYYMMDDTHHMM.QGIS3.zip) and click Install plugin.
Start the EnMAP-Box via the icon or from the menubar Raster ‣ EnMAP-Box.