Commit 2295ccd0 authored by Antoine Kaufmann's avatar Antoine Kaufmann Committed by Antoine Kaufmann
Browse files

doc: add getting started section draft

Also adding some labels needed for referencing various parts of the
rest of the documentation.
parent 7d80bffc
...@@ -21,6 +21,8 @@ ...@@ -21,6 +21,8 @@
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.. _sec-devel:
################################### ###################################
Developer Guide Developer Guide
################################### ###################################
......
...@@ -21,15 +21,22 @@ ...@@ -21,15 +21,22 @@
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.. _sec-howto:
################################### ###################################
How To How To
################################### ###################################
.. _sec-howto-createrun:
****************************** ******************************
Create and Run an Experiment Create and Run an Experiment
****************************** ******************************
.. _sec-howto-nodeconfig:
******************************** ********************************
Add a Node or Application Config Add a Node or Application Config
******************************** ********************************
......
...@@ -29,10 +29,22 @@ Installing ...@@ -29,10 +29,22 @@ Installing
System Requirements System Requirements
****************************** ******************************
.. _sec-docker-images:
****************************** ******************************
Docker Images Docker Images
****************************** ******************************
Pre-Built
=========
Building Images
===============
.. _sec-install-build:
****************************** ******************************
Building from Source Building from Source
****************************** ******************************
......
...@@ -21,6 +21,8 @@ ...@@ -21,6 +21,8 @@
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.. _sec-orchestration:
################################### ###################################
SimBricks Orchestration SimBricks Orchestration
################################### ###################################
......
...@@ -25,10 +25,44 @@ ...@@ -25,10 +25,44 @@
Getting Started Getting Started
################################### ###################################
****************************** Welcome! We are happy that you want to give SimBricks a try.
Overview
******************************
****************************** The easiest way to get started with just running a simulation is to use our
Resources Docker images, see :ref:`sec-docker-images`. Given a working docker installation
****************************** (`docker engine <https://docs.docker.com/engine/install/#server>`_ or `docker
desktop <https://docs.docker.com/get-docker/>`_ both work), this is as simple
as just launching a new container and docker will take care of the rest:
.. code-block:: bash
$ docker run -it simbricks/simbricks /bin/bash
If you have a host system with support for KVM virtualization, you can greatly
speed up many simulations (and building images) by passing through the KVM
device into the container:
.. code-block:: bash
$ docker run --device=/dev/kvm --privileged -it simbricks/simbricks /bin/bash
Now you are ready to run your first SimBricks simulation (in the container):
.. code-block:: bash
$ 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.
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 :ref:`sec-install-build`. Before 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
...@@ -33,6 +33,9 @@ Is my Simulation Stuck or just Slow? ...@@ -33,6 +33,9 @@ Is my Simulation Stuck or just Slow?
Understanding Simulation Performance Understanding Simulation Performance
************************************ ************************************
.. _sec-troubleshoot-getting-help:
****************************** ******************************
Getting Help 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