Installation

Supported Python versions:

Setting up a virtual environment

We recommend installing GeoRacoon in a virtual environment to avoid dependency conflicts.

On macOS and Linux:

$ python -m venv .venv
$ source .venv/bin/activate

On Windows:

PS> python -m venv .venv
PS> .venv\Scripts\activate

Installing GeoRacoon

GeoRacoon is available on PyPI and can be installed with:

pip install GeoRacoon

To install the latest version directly from GitHub into your virtual environment, run:

pip install git+https://github.com/GeoRacoon/georacoon.git

Development installation

You can also clone the repository and install the package from your local copy. This is the recommended strategy if you intend to work on the source code, allowing you to modify the files in-place.

To install:

1. Clone this repository

2. cd into the repository

On macOS and Linux:

$ python -m pip install -e .

On Windows:

PS> python -m pip install -e .

Note: This package relies on rasterio which partially depends on libgdal. If you follow the installation instructions below you will attempt to install rasterio from the Python Package Index in which case the libgdal library will be shipped along. However, if you encounter any issues with the installation of rasterio, head over to the rasterio installation instructions for more details.

We also use the python package gdal which depends on libgdal that has been installed (see comment above). It is important to install matching version, so first check with gdalinfo --version what version of libgdal you have installed and then install the corresponding python package with pip install gdal==x.x.x.

Installation with `uv`

If you prefer using uv, you can install GeoRacoon as follows:

$ uv pip install GeoRacoon

For development installation with uv:

$ git clone https://github.com/GeoRacoon/GeoRacoon.git
$ cd GeoRacoon
$ uv pip install -e .