Commit 4f7ef90d authored by Jonas Kaufmann's avatar Jonas Kaufmann Committed by Antoine Kaufmann
Browse files

doc/howto.rst: tweak 'Integrate a New Simulator'

parent 18f80c74
...@@ -125,16 +125,19 @@ Add a Custom Image ...@@ -125,16 +125,19 @@ Add a Custom Image
Integrate a New Simulator Integrate a New Simulator
****************************** ******************************
The first step when integrating a new simulator into SimBricks is to implement a The first step is to implement a SimBricks adapter in the simulator you want to
SimBricks adapter for it. You can find the necessary information in the integrate. This adapter on one side uses the simulator's extension API to act as
:ref:`Simulator Adapters <Simulator Adapters>` section. To then make running a native device and on the other side sends and receives SimBricks messages. You
experiments and setting up the communication channels with other simulators more can find more information on adapters in our :ref:`page-architectural-overview`.
convenient, add a class for the simulator to the orchestration framework that
inherits from :class:`~simbricks.orchestration.simulators.Simulator` or one of To make running experiments and setting up the SimBricks communication channels
the more specialized base classes in :mod-orchestration:`simulators.py`. In to other simulators convenient, add a class for the simulator in
this class you define the command to execute the simulator together with further :mod-orchestration:`simulators.py`` that inherits either from
parameters, for example, to connect to the communication channels with other :class:`~simbricks.orchestration.simulators.Simulator` or one of the more
simulators. Below is an example of what this looks like. specialized base classes in. In this class, you define the command(s) to execute
the simulator together with further parameters, for example, to connect to the
communication channels with other simulators. Below is an example of what this
looks like.
.. code-block:: python .. code-block:: python
:linenos: :linenos:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment