1. Installation

Important

The EO Time Series Viewer plugin requires QGIS >= 3.38 < 4, GDAL >= 3.10, and Python >= 3.10

1.1. Install QGIS & Python Dependencies

Download and install the OSGeo4W Network Installer
Use the OSGeo4W installer to install:

the latest QGIS relase (LR, qgis) or QGIS long term release (LTR, qgis-ltr)

the python3-pip package

Fig. 1.1.1 OSGeo4W Network Installer

The OSGeo4W neotwork installer can be used to update QGIS and have different QGIS releases installed in parallel.

If python-packages are missing:

try installing them using the OSGeo4W installer first.

If unavailable in the OSGeo4W installer, install them by running pip install <package> from the OSGeo4W shell

Conda is a cross-platform package manager that allows to install software in separated environments. We recommend to install conda using Miniforge, a minimal installer which by default installs conda packages from the conda-forge channel.

Install conda

Linux / Unix / MacOS
# download install script
curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"

# run install script
sh Miniforge3-$(uname)-$(uname -m).sh
Windows

Download and run the miniforge installer from https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe

Install QGIS + Python dependencies

Open a terminal with conda available and install a new python environment with QGIS and all required python packages:
conda install -n eotsv -f=https://raw.githubusercontent.com/jakimowb/eo-time-series-viewer/refs/heads/main/.conda/eotsv.yml
Now activate the environment and start QGIS
conda activate eotsv
qgis

Pull a QGIS image, e.g., qgis/qgis:stable

docker pull qgis/qgis:stable

Download the QGIS start script created by David Frantz from https://github.com/davidfrantz/startup/blob/main/bash/qgis.sh into a local folder and allow executing it

cd ~
wget https://raw.githubusercontent.com/davidfrantz/startup/refs/heads/main/bash/qgis.sh
chmod +x qgis.sh

Call the script to run QGIS from docker

./qgis.sh -v stable

1.2. Install the EO Time Series Viewer plugin

Open QGIS
In the menu bar go to Plugins ‣ Manage and Install Plugins…
Switch to the All tab and search for EO Time Series Viewer
Click on Install Plugin to start the installation
Start the EO Time Series Viewer via the icon or from the menu bar Raster ‣ EO Time Series Viewer

Fig. 1.2.1 Installing the EO Time Series Viewer plugin

1.3. Developers

Clone the eo-time-series-viewer repository and ensure that all submodules are checkout:

git clone --recurse-submodules git@github.com:jakimowb/eo-time-series-viewer.git
cd eo-time-series-viewer
git submodule update --init --recursive

Ensure that your python has the QGIS API available. You can use the the eotsv.yml conda environment to install QGIS and other required python packages:

conda env create -n eotsv --file=.conda/eotsv.yml
conda activate eotsv

Run scripts/setup_repository.py to download and create qt resource files.

This ensures icons to become visible even if the EOTSV is started from python instead of the QGIS GUI.
Call timeseriesviewer/__main__.py to start the EOTSV from python

python eotimeseriesviewer/__main__.py
Fig. 1.3.1 The EOTSV GUI, as started from a python shell