User Tools

Site Tools


user-guide:additional_interfaces:additional_interfaces

Additional User interfaces

Besides the Graphical user interface that is used in GroIMP by default, it is possible to execute models in other ways. This can be useful for specific scenarios such as larger pipelines or remote execution. In general a user interface describes how the user communicates with the software (GroIMP).

UserGroIMPUserGroIMP???

For example with the graphical user interface windows and panels are used for this communication:

GUIGUIUserWindows/panelsGroIMPUserWindows/panelsGroIMPStart GroIMP

Headless mode

GroIMP can be started without its graphical interface, in headless. The headless mode executes a provided model and afterwards closes GroIMP. Capturing any feedback from the simulation must be included in the model.

HeadlessHeadlessUserGroIMPUserGroIMPStart GroIMP with modelPrint log & close GroIMP

More information on the headless mode:

A tutorial:

Command Line Interface

GroIMP can be started without its graphical interface, with a CLI. Unlike the Headless mode, the CLI enables interaction with the model during run time including opening and closing models, running simulations, editing RGG files etc.

CLICLIUserInteractive command lineGroIMPUserInteractive command lineGroIMPStart GroIMP

More documentation on the CLI:

A tutorial:

HTTP Server

It is possible to start GroIMP as a HTTP server to then send model paths via HTTP for GroIMP to execute. After GroIMP executed the model values can be returned to the HTTP client who send the request. It is possible to send several models in series or in parallel.

HTTP serverHTTP serverUserGroIMPUserGroIMPStart GroIMPSend Model-pathReturn resultClose GroIMP

More information:

Tutorial:

Application Programming Interface

GroIMP can be started as an HTTP API that provides a generalized set of commands that allows the interaction with other software. Currently a Python and a R library are provided but any software capable of http requests could interact with GroIMP.

APIAPIUserClientScriptAPIGroIMPUserClientScriptAPIGroIMPStart GroIMPStop GroIMP
More information on the API:

Tutorials:

Existing examples:

GroIMP Server

This Feature is currently not working!!!!

GroIMP can be started as a server. Then, other instances of GroIMP can connect to the GroIMP server. This enables multiple user concurrently accessing a single model from different devices as well as modelling on a powerful remote server.

GroIMP serverGroIMP serverUserclient GroIMPremote GroIMPUserclient GroIMPremote GroIMPstarts server side GroIMPstarts client GroIMPstops client GroIMPstops server side GroIMP
More information:

Tutorial:

GreenLab

Parts of the GreenLab model were reimplemented in the language XL with additional panels in the GUI. As the basis, the implementation of the GreenLab model in the software GreenScilab, version GreenScilabv1.0_demo, was taken.

More information on the Greenlab plugin:

A tutorial:

user-guide/additional_interfaces/additional_interfaces.txt · Last modified: 2025/01/17 09:52 by Tim