Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 3.23 KB

installation.md

File metadata and controls

84 lines (52 loc) · 3.23 KB
Raw

(installation)=

🐛 Installation

:local:
:depth: 1

The following sections provide information how to install EOmaps.

  • A quick tutorial on how to get started from scratch is available here: {ref}quickstart_guide
  • More details on how to configure your favorite IDE to get the most out of EOmaps can be found in the {ref}faq section {ref}configuring_the_editor.
  • If you want to know how to setup EOmaps for development, have a look at the {ref}contribute

Installation with conda or mamba

EOmaps is available on conda-forge and can be installed via:

conda install -c conda-forge eomaps

This will install all required dependencies as well as the optional dependencies pandas, geopandas, mapclassify, datashader, owslib, requests and qtpy

:::{dropdown} Greatly speed up the installation! :color: info :icon: info :open: :margin: 3

Since the dependencies of EOmaps can be demanding to solve for conda, it is highly recommended that you use mamba to install EOmaps in a conda-environment!

mamba is a reimplementation of the conda package manager in C++, capable of solving environments a lot faster.

The recommended way to get started is to use miniforge, a minimalistic installer that provides both conda and mamba, pre-configured to use the conda-forge channel by default. For other options, checkout the mamba-docs

Once mamba is installed, you just need to replace the term conda with mamba and you're good to go!

mamba install -c conda-forge eomaps

:::

Installation with pip

EOmaps is also available on pypi.

To install EOmaps with a minimal set of dependencies, use:

pip install eomaps

Optional dependencies

Some features ({ref}webmap_layers, {ref}companion_widget, etc.) require additional dependencies. To use them you have to install the required dependency-groups:

To get all features of EOmaps, you can use one of:

  • pip install eomaps[all] Install ALL requuired and optional dependencies
  • pip install eomaps[all_nogui] Same as all but without installing the Qt GUI framework

In addition, you can use the following dependency-groups to activate only selected features:

  • pip install eomaps[wms] Add dependencies required to use {ref}WebMap services <webmap_layers>
  • pip install eomaps[gui] Add dependencies for Qt GUI framework (and the {ref}CompanionWidget <companion_widget>)
  • pip install eomaps[io] Add support for pandas, xarray, geopandas and rioxarray
  • pip install eomaps[shade] Add capabilities to visualize extremely large datasets (via datashader)
  • pip install eomaps[classify] Add support for mapclassify to classify datasets

It is also possible to combine dependency-groups, e.g.: pip install eomaps[wms, gui].

A full list of all associated packages can be found in {ref}setup_a_dev_env or in the pyproject.toml file.