Table of Contents
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.
Starting with GroIMP 2.1 the API application is included and can be started with the following command:
java -Xverify:none -jar core.jar --headless -a api
This starts a local web server, the default port is 58081, this
can be changed either in the preferences panel in the GUI or by
adding -Xport=58080
to the command above. A
more in-depth explanation of GroIMP arguments can be found
here.
Now the API can be reached at http://localhost:58081/api. This will return an error message since no command was given.