Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ycai
simbricks
Commits
4f7ef90d
Commit
4f7ef90d
authored
May 07, 2024
by
Jonas Kaufmann
Committed by
Antoine Kaufmann
May 08, 2024
Browse files
doc/howto.rst: tweak 'Integrate a New Simulator'
parent
18f80c74
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
10 deletions
+13
-10
doc/user/howto.rst
doc/user/howto.rst
+13
-10
No files found.
doc/user/howto.rst
View file @
4f7ef90d
...
...
@@ -125,16 +125,19 @@ Add a Custom Image
Integrate a New Simulator
******************************
The first step when integrating a new simulator into SimBricks is to implement a
SimBricks adapter for it. You can find the necessary information in the
:ref:`Simulator Adapters <Simulator Adapters>` section. To then make running
experiments and setting up the communication channels with other simulators more
convenient, add a class for the simulator to the orchestration framework that
inherits from :class:`~simbricks.orchestration.simulators.Simulator` or one of
the more specialized base classes in :mod-orchestration:`simulators.py`. In
this class you define the command 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.
The first step is to implement a SimBricks adapter in the simulator you want to
integrate. This adapter on one side uses the simulator's extension API to act as
a native device and on the other side sends and receives SimBricks messages. You
can find more information on adapters in our :ref:`page-architectural-overview`.
To make running experiments and setting up the SimBricks communication channels
to other simulators convenient, add a class for the simulator in
:mod-orchestration:`simulators.py`` that inherits either from
:class:`~simbricks.orchestration.simulators.Simulator` or one of the more
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
:linenos:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment