GroIMP wiki - 02_user_tutorials:30_additional_interfaces:api
https://dokuwiki.grogra.de/
2026-05-16T09:14:10+00:00GroIMP wiki
https://dokuwiki.grogra.de/
https://dokuwiki.grogra.de/lib/exe/fetch.php?media=wiki:dokuwiki.svgtext/html2025-12-12T10:48:53+00:00Anonymous (anonymous@undisclosed.example.com)Start GroIMP in API mode
https://dokuwiki.grogra.de/doku.php?id=02_user_tutorials:30_additional_interfaces:api:01_startup-api&rev=1765536533&do=diff
Start GroIMP in API mode
Using the GroIMP API it is possible to use GroIMP as a service, or from a remote server.
Installing the API plugin
The API can be installed using the plugin manager, to do so please go on help / plugin manager and select under available plugins the plugintext/html2025-12-12T14:00:56+00:00Anonymous (anonymous@undisclosed.example.com)Getting started with GroLink and HTTP
https://dokuwiki.grogra.de/doku.php?id=02_user_tutorials:30_additional_interfaces:api:02_getting-started-with-grolink-and-http&rev=1765548056&do=diff
Getting started with GroLink and HTTP
To show the usage of the API without a client library this tutorial uses HTTP calls by just opening them in the webbrowser. This Tutorial shows only a limited functionality because HTML hyperlinks can not send a request body.text/html2025-12-10T12:14:13+00:00Anonymous (anonymous@undisclosed.example.com)Getting started with GroLink and GroPy
https://dokuwiki.grogra.de/doku.php?id=02_user_tutorials:30_additional_interfaces:api:03_getting-started-with-grolink-and-gropy&rev=1765368853&do=diff
Getting started with GroLink and GroPy
To improve the usability of the API, the GroLink project includes a Python library, that links Python code to the running API server.
Requirements
* A GroIMP version including the API plugin is needed, the first version including thetext/html2025-12-10T12:14:13+00:00Anonymous (anonymous@undisclosed.example.com)Getting started with GroLink and GroR
https://dokuwiki.grogra.de/doku.php?id=02_user_tutorials:30_additional_interfaces:api:04_getting-started-with-grolink-and-gror&rev=1765368853&do=diff
Getting started with GroLink and GroR
To improve the usability of the API, the GroLink project includes a R library, that links R code to the running API server.
Requirements
* A GroIMP version including the API plugin is needed, the first version including thetext/html2025-12-10T12:14:11+00:00Anonymous (anonymous@undisclosed.example.com)Handeling data in GroLink Projects
https://dokuwiki.grogra.de/doku.php?id=02_user_tutorials:30_additional_interfaces:api:05_handeling-data-in-grolink-projects&rev=1765368851&do=diff
Handeling data in GroLink Projects
Many GroIMP projects use external data such as csv or xls files by linking these files in RGG code. This will (with the right path) work on the API in the same way. Except if the GroIMP and the API are executed on another device.text/html2025-12-10T12:14:13+00:00Anonymous (anonymous@undisclosed.example.com)Sensitivity analysis on GroIMP models using GroR
https://dokuwiki.grogra.de/doku.php?id=02_user_tutorials:30_additional_interfaces:api:06_sensitivity-analysis-using-grolink-and-gror&rev=1765368853&do=diff
Sensitivity analysis on GroIMP models using GroR
This wiki explains how to do a sensitivity analysis on GroIMP models using the GroR interface using a Morris screening over input parameters of the "Example08" FSPM model from the gallery as an example.
Prerequisites
Make sure totext/html2025-12-10T12:14:13+00:00Anonymous (anonymous@undisclosed.example.com)Deploying GroIMP/GroLink on Kubernetes
https://dokuwiki.grogra.de/doku.php?id=02_user_tutorials:30_additional_interfaces:api:07_grolink-on-kubernetes&rev=1765368853&do=diff
Deploying GroIMP/GroLink on Kubernetes
This tutorial is a first step towards deploying GroIMP on a compute cluster. This at the moment is more of a prove of concept than a established way of using GroIMP.
The idea is to have several multiple pods running the GroIMP