Commit 3a95a1b6 authored by Jonas Kaufmann's avatar Jonas Kaufmann Committed by Antoine Kaufmann
Browse files

howto.rst, quickstart.rst: pass over existing content

parent 644ec664
......@@ -84,20 +84,20 @@ experiment. If ``simbricks-run`` is not available, you can always do
$ cd experiments
$ python run.py --verbose --force <path_to_your_module.py>
While running, you can interrupt the experiment using CTRL+C in your terminal.
While running, you can interrupt the experiment using Ctrl+C in your terminal.
This will cleanly stop all simulators and collect their output in a JSON file in
the directory ``experiments/out/<experiment_name>``. These are the necessary
basics to create and run your first experiment. Have fun.
.. literalinclude:: /../experiments/pyexps/simple_ping.py
:linenos:
:lines: 25-
:lines: 29-
:language: python
:name: simple_ping_experiment
:caption: A simple experiment with a client host pinging a server, both are
connected through a network switch. The setup of the two hosts could be
simplified by using
:func:`~simbricks.orchestration.simulator_utils.create_basic_hosts`.
:func:`simbricks.orchestration.simulator_utils.create_basic_hosts`.
.. _sec-howto-nodeconfig:
......@@ -106,7 +106,7 @@ Add a Node or Application Config
********************************
The configuration for a host and the commands to run for your workload are
defined via a :ref:`sec-node_config` and :ref:`sec-app_config`. SimBricks
defined via a :ref:`sec-node-config` and :ref:`sec-app-config`. SimBricks
already offers some concrete implementations in the module
:mod:`simbricks.orchestration.nodeconfig`. If they don't fit your use-case, you
need to implement your own by overwriting the pre-defined member functions.
......@@ -170,6 +170,3 @@ below of adding a class for the ``NS3`` network simulator.
******************************
Add a New Interface
******************************
.. automodule:: simbricks.orchestration.simulator_utils
:members:
......@@ -98,7 +98,7 @@ found in the module. :mod:`simbricks.orchestration.simulators`.
.. autoclass:: simbricks.orchestration.simulators.PCIDevSim
.. _sec-node_configuration:
.. _sec-node-config:
Node Configuration
==================
......@@ -122,7 +122,7 @@ for a :class:`~simbricks.orchestration.nodeconfig.AppConfig`.
:members: ip, prefix, mtu, cores, memory, disk_image, app, run_cmds, cleanup_cmds, config_files
.. _sec-app_configuration:
.. _sec-app-config:
Application Configuration
-------------------------
......@@ -140,16 +140,12 @@ simulators.
:members: run_cmds, config_files
.. _sec-command-line:
******************************
Running Experiments
******************************
.. _sec-command-line:
Command Line
====================
To run experiments using our orchestration framework, use the
``experiments/run.py`` script. For your convenience, you can also use
``simbricks-run`` in the Docker images from anywhere to run experiments. In
......
......@@ -54,18 +54,19 @@ Now you are ready to run your first SimBricks simulation (in the container):
$ cd experiments
$ simbricks-run --verbose --force pyexps/qemu_i40e_pair.py
Where you go from here depends on what you plan to do with SimBricks. Our How-To
section, see :ref:`sec-howto`, provides instructions for some common scenarios.
In general, we suggest starting with reading up on our orchestration framework,
see :ref:`sec-orchestration`, and experimenting with building different
simulation configurations, e.g. :ref:`sec-howto-createrun` and
:ref:`sec-howto-nodeconfig`. This will enable you to assemble and customize
various configurations of SimBricks simulations.
Where you go from here depends on what you plan to do with SimBricks. Our
:ref:`sec-howto` section provides instructions for some common scenarios. In
general, we suggest starting with reading up on our orchestration framework, see
:ref:`sec-orchestration`, and experimenting with building different simulation
configurations, e.g. :ref:`sec-howto-createrun` and :ref:`sec-howto-nodeconfig`.
This will enable you to assemble and customize various configurations of
SimBricks simulations.
If you are planning on making changes to the implementation of SimBricks
components, you may next want to make sure you can build SimBricks from source,
see our `Quick Start section in the README <https://github.com/simbricks/simbricks#quick-start>`_. We
recommend diving into our :ref:`sec-devel` for learning about the SimBricks
architecture, internals, and APIs.
see our `Quick Start section in the README
<https://github.com/simbricks/simbricks#quick-start>`_. We recommend diving into
our :ref:`sec-devel` for learning about the SimBricks architecture, internals,
and APIs.
If you run into problems please refer to :ref:`sec-troubleshoot-getting-help`.
\ No newline at end of file
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