Skip to content

REST API

Modelon Impact client libraries makes it easy to programmatically connect and interact with a Modelon Impact server.

The libraries wrap the Modelon Impact REST API framework and helps with:

  1. Authenticate users against Modelon Impact
  2. Creating and automating custom workflows in your favorite programming language
  3. Defining and executing simulations on the Impact server
  4. Compiling models on the server and downloading them as FMUs
  5. Fetching results and do post-processing

Available client libraries for Modelon Impact:

  • Python - Targets scripting and workflow automation.

  • JavaScript - Targets web-app development.

The Python library client is recommended for most use cases.

REST API🔗

REST stands for Representational State Transfer. A REST API is an application programming interface that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services.

Modelon Impact has a low-level web-interface (REST API) that the client libraries are wrapping. The documentation is available here.