Documentation of the SIMONA API

Welcome to the documentation of the SIMONA API. This API is used to create extensions for SIMONA. One example are external simulations, that can be used in co-simulations with SIMONA.

Contents:

• Getting started
  • Requirements
  • Where to get
  • Important changes
• API Structure
  • Data
  • Exceptions
  • Mapping
  • Ontology
  • Simulation
  • External link interface
• How to create external simulations for SIMONA
  • Defining the service
  • Project with multiple external simulations
• External link interface
  • Setting up the external simulation
  • Getting the external simulation
• External simulation
  • Initializing the external simulation
  • Performing an activity
  • Returning the data connections
  • Communication between SIMONA and an external simulation
  • Co-simulations
• Data connections
  • Input data connections
  • Output data connections
  • Bidirectional data connections
  • External simulation data connection
• Setup data

Contact the (Main) Maintainers

If you feel, something this missing, wrong or misleading, please contact one of our main contributors:

• @t-ober

• @danielfeismann

• @sebastian-peter

• @jo-bao

• @staudtMarius

Hat tip to all other contributors!

Indices and tables

• Index

• Module Index

• Search Page