Installation

The geospatial package has many dependencies, such as GeoPandas and localtileserver. These optional dependencies can sometimes be a challenge to install, especially on Windows. Therefore, we advise you to closely follow the recommendations below to avoid installation problems.

Video Tutorial

Installing with Anaconda/Miniconda

To install geospatial and all its dependencies, we recommend you use the conda package manager. This can be obtained by installing the Anaconda Distribution (a free Python distribution for data science), or through Miniconda (minimal distribution only containing Python and the conda package manager). See also the installation docs for more information on how to install Anaconda or Miniconda locally.

Using the conda-forge channel

Geospatial is available on the conda-forge channel, a community effort that provides conda packages for a wide range of software.

conda install -c conda-forge geospatial

Creating a new conda environment

Creating a new environment is not strictly necessary, but given that some geospatial dependencies might have a version conflict with other geospatial packages in an existing conda environment, it is a good practice to install geospatial and its dependencies in a clean environment starting fresh.

The following commands create a new conda environment with the name geo and install geospatial and its dependencies (e.g., GeoPandas, localtileserver) in it:

conda create -n geo python=3.9
conda activate geo
conda install geopandas
conda install geospatial -c conda-forge

Important note: If you are using Windows, we advise you to closely follow the installation instructions above to install GeoPandas from the default conda channel (conda install geopandas) rather than from the conda-forge channel. This can avoid a potential spatialindex_c-64.dll error when using GeoPandas (source). If you are using Linux or macOS, it is okay to install all geospatial dependencies from the conda-forge channel with the following command:

conda install -c conda-forge geospatial

Using Mamba

When installing packages using the conda package manager, sometimes it can take a while for conda to resolve dependencies. If it takes too long or fails to resolve dependencies, you can try using the Mamba package manager to install geospatial and its dependencies. Mamba is a fast, robust, and cross-platform package manager. It runs on Windows, macOS, and Linux, and is fully compatible with conda packages and supports most of conda’s commands. Once Mamba is installed in a conda environment, you can then simply replace any conda command with mamba. For example, to install geospatial and its dependencies with Mamba, you can use the following commands:

conda create -n geo python=3.9
conda activate geo
conda install -c conda-forge mamba
mamba install geopandas
mamba install -c conda-forge geospatial

Installing with pip

geospatial is also available on PyPI. It can be installed with pip using the following command:

pip install geospatial

All optional dependencies of geospatial are listed in requirements_dev.txt.

Installing from source

You may install the latest development version by cloning the GitHub repository with Git and using pip to install from the local directory:

git clone https://github.com/opengeos/geospatial.git
cd geospatial
pip install .

It is also possible to install the latest development version directly from the GitHub repository with:

pip install git+https://github.com/opengeos/geospatial.git

Using Docker

If you are familiar with Docker, you can use the following command to pull the latest geospatial image from the GitHub Container Registry

docker pull ghcr.io/opengeos/geospatial:latest

Upgrading geospatial

If you have installed geospatial before and want to upgrade to the latest version, you can run the following command in your terminal:

pip install -U geospatial

If you use conda, you can update geospatial to the latest version by running the following command in your terminal:

conda update -c conda-forge geospatial

---

Last update: 2024-03-18