Differences

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

--- user-guide:additional_interfaces:api [2025/01/22 15:52] – Tim
+++ user-guide:additional_interfaces:api [2025/02/07 17:12] (current) – [Examples] Tim
@@ Line 1: / Line 1: @@
-====== API GroIMP user guide ======
+====== API ======
 GroIMP can be started as an HTTP API that provides a generalized set of commands allowing interaction from other software. Currently a Python and a R library are provided but any software capable of HTTP requests could interact with GroIMP. This approach can be used to automatically start a simulation and interact with it during the execution.
@@ Line 191: / Line 191: @@
 ===== More documentation =====
- * [[https://wkurth.grogra.de/oberlaender_msc.pdf| GroLink: implementing and testing a general application programming interface for the plant-modelling platform GroIMP (original Thesis)]]
- * [[: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 (original Thesis)]]
+  * [[:groimp-platform:interfaces:api|API implementation]]
 ===== Tutorials =====
+  * [[:Tutorials:Startup-API |Start the API]]
   * [[: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)]]
@@ Line 204: / Line 207: @@
 ===== Examples =====
-  * [[https://gitlab.com/groimp-api-examples/pythonnotebook|Python Notebook]]
-  * [[https://gitlab.com/groimp-api-examples/forester-game|Godot Game]]
-  * [[https://gitlab.com/groimp-api-examples/apiplus|example Addition]]
+We provide examples in Python, R and Godot to get a first impression: https://gitlab.com/groimp-api-examples.
+Additionally you can find there a ready to use docker container to ease the first tests.