Skip to main content

GIS utilities for Tim(ML) Analytic Element modeling

Project description

Documentation: https://deltares.gitlab.io/imod/qgis-tim

This repository contains two Python packages:

  • ./plugin contains the source code for a QGIS plugin. This plugin provides a limited graphical interface to setup a GeoPackage containing the vector data required by a TimML analytic element model and read results.
  • ./gistim contains the functions required to transform a GeoPackage into a TimML model. It is fully independent of the plugin, relying on packages such as rasterio and geopandas instead of QGIS functions. The utilities it provides can be used independently of QGIS, in a fully scripted workflow.

Installation requirements

In terms of development requirements, the packages are independent as well. The plugin requires:

  • A modern (>=3.0) QGIS installation, within the context of OSGeo4W. A basic QGIS installation (as can be gotten here suffices to run the plugin, but will not suffice for full development capabilities.

The QGIS installation comes with its own Python installation and interpreter. This installation does not provide a package manager such as conda. This complicates the distribution of complex binary dependencies. Hence, the gistim package (and TimML) should run in a different interpreter. This requires:

Rasterio, rioxarray, and netCDF4 are optional dependencies but output options are severely limited without them. Both geopandas and rasterio requires GDAL, which is a heavy and complex binary dependency. It is highly recommended to install these packages via conda in a separate environment – the specification is included in the environment.yml of this repository.

See the installation instruction below.

Installing the plugin in QGIS

There are a few ways to install this plugin:

  • Copy the directory ./plugin/qgistim to your local QGIS plugins directory. On Windows, this should be located at:

    c:\Users\{username}\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins

    The location can be found in the QGIS GUI via:

    QGIS menu > Settings > User Profiles > Open Active Profile Folder

  • Alternatively, zip the ./plugin/qgistim directory. Then, in the Plugins menu, under “Manage and Install Plugins…”, find “Install from ZIP”, and enter the path to the zipfile – this unzips the files and copies them to the directory mentioned above.

The plugin is good to go now. Find the Qgis-Tim entry in the Plugins menu, and click it to open a docked menu on the right side of your QGIS screen.

Installing the Python package

The recommended way of installing is using conda, in a separate conda environment. This environment (called tim) can be setup by downloading the environment.yml and running the following command in the anaconda prompt:

conda env create -f environment.yml

After creation, the conda environment can be activated by running the following command in the anaconda prompt:

conda activate tim

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gistim, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size gistim-0.1-py3-none-any.whl (21.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size gistim-0.1.tar.gz (3.4 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page