GroIMP wiki

a part of grogra.de

User Tools

Site Tools

Trace:
user-guide:additional_interfaces

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
user-guide:additional_interfaces [2025/01/22 15:53] – created Timuser-guide:additional_interfaces [2025/06/04 12:40] (current) – tim2
Line 30: Line 30:
    
  
-====== Headless mode ====== +If you are not sure what interface you need for your application you can consider the following page: [[user-guide:additional_interfaces_where_to_start|What interface do I need]]
- +
-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. +
- +
-<uml> +
-@startuml +
-hide footbox +
-title Headless +
- +
-User -> GroIMP: Start GroIMP with model +
-GroIMP -> User: Print log & close GroIMP +
-@enduml +
-</uml> +
- +
- +
-More information on the headless mode: +
-  * [[user-guide:additional_interfaces:headless|GroIMP headless user guide]] +
-  * [[:groimp-platform:interfaces:headless|Headless implementation]] +
-  * [[:user-guide:advanced-groimp-arguments|Common command line arguments]] +
- +
-A tutorial: +
-  * [[:tutorials:startup-headless-model|Getting started with headless]] +
- +
- +
- +
-====== 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. +
- +
-<uml>@startuml +
-!pragma teoz true +
-hide footbox +
-title CLI +
-participant User +
-participant "Interactive command line" as cli +
-participant GroIMP +
- +
- +
-User -> GroIMP: Start GroIMP +
-cli<-> GroIMP +
-& User <-> cli +
- +
-@enduml</uml> +
- +
-More documentation on the CLI: +
-  * [[:user-guide:additional_interfaces:cli | CLI user guid]] +
-    * [[:user-guide:additional_interfaces:cli#list_of_commands|List of CLI commands]] +
-  * [[:groimp-platform:interfaces:cli|CLI implementation]] +
-A tutorial: +
-  * [[:tutorials:startup-cli-model|Getting started with CLI]] +
- +
-====== 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.   +
- +
-<uml>@startuml +
-hide footbox +
-title HTTP server +
- +
-User -> GroIMP: Start GroIMP +
-User -> GroIMP: Send Model-path +
-GroIMP -> User: Return result +
-User -> GroIMP: Close GroIMP +
- +
-@enduml</uml> +
- +
- +
-More information: +
-  +
-  * [[:user-guide:additional_interfaces:http| HTTP server user guide]] +
-    * [[:user-guide:additional_interfaces:http#commands|HTTP Server commands]] +
-    * [[:user-guide:additional_interfaces:http#options|HTTP options]] +
-Tutorial: +
-  * [[:tutorials:http_server|Starting GroIMP as a HTTP Server]] +
- +
-====== 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. +
- +
- +
-<uml> +
-@startuml +
-!pragma teoz true +
-hide footbox +
-title API +
- +
-participant User +
-participant ClientScript +
-participant API +
-participant GroIMP +
- +
- +
-User -> GroIMP: Start GroIMP +
-User -> ClientScript +
-ClientScript <->API +
-& API<-> GroIMP +
-User <- ClientScript +
-User -> GroIMP: Stop GroIMP +
- +
- +
-@enduml +
-</uml> +
-More information on the API: +
- +
-  * [[:user-guide:additional_interfaces:api |API user guid]] +
-  * [[https://gitlab.com/grogra/groimp-plugins/api/-/blob/master/commands.md|List of commands]] +
-  * [[:groimp-platform:interfaces:api|API implementation]] +
-  * [[https://wkurth.grogra.de/oberlaender_msc.pdf| GroLink: implementing and testing a general application programming interface for the plant-modelling platform GroIMP]] +
- +
-Tutorials: +
-  * [[:Tutorials:Getting-started-with-GroLink-and-GroPy|getting started with GroLink and Python(GroPy)]] +
-  * [[:Tutorials:Getting-started-with-GroLink-and-GroR|getting started with GroLink and R(GroR)]] +
-  * [[:Tutorials:Getting-started-with-GroLink-and-HTTP|getting started with GroLink and HTTP in your web browser]] +
-  * [[:Tutorials:Handeling-data-in-GroLink-Projects|Handling data in GroLink projects]] +
-  * [[:Tutorials:grolink-on-kubernetes|Deploying GroIMP/GroLink on Kubernetes]] +
-  * [[:dev-guide:create-new-api-function|How to create new API commands]] +
- +
-Existing examples: +
-  * [[https://gitlab.com/groimp-api-examples/forester-game | Godot forestry Game]] +
-  * [[https://gitlab.com/groimp-api-examples/pythonnotebook | An jupyter notebook]] +
-  * [[https://gitlab.com/groimp-api-examples/shinyexamples | Two R-Shiny apps to view GroIMP projects in a browser]] +
- +
  
 +======  ======
  
 +{{namespace>user-guide:additional_interfaces}}
  
 ====== GroIMP Server ====== ====== GroIMP Server ======
user-guide/additional_interfaces.1737557623.txt.gz · Last modified: 2025/01/22 15:53 by Tim