doc: update outline

doc/index.rst

 ..
-  Copyright 2021 Max Planck Institute for Software Systems, and
+  Copyright 2022 Max Planck Institute for Software Systems, and
   National University of Singapore
 ..
   Permission is hereby granted, free of charge, to any person obtaining
@@ -24,6 +24,11 @@
 SimBricks
 =========
 
+The SimBricks documentation comprises three parts. The first part focuses on
+using SimBricks as is, the second part on internals and developer information
+for extending SimBricks, and the third part contains information on specific
+component simulators. The first part is typically where you should start.
+
 .. toctree::
    :numbered:
    :maxdepth: 2
@@ -31,10 +36,4 @@ SimBricks
 
    user
    devel
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   simulators
\ No newline at end of file

doc/simulators.rst

+..
+  Copyright 2022 Max Planck Institute for Software Systems, and
+  National University of Singapore
+..
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+..
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+..
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+###################################
+Simulators
+###################################
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+

doc/user.rst

@@ -30,5 +30,7 @@ User Guide
    :caption: Contents:
 
    user/quickstart
-   user/parameters
+   user/install
+   user/orchestration
+   user/howto
    user/troubleshooting

doc/user/howto.rst

+..
+  Copyright 2022 Max Planck Institute for Software Systems, and
+  National University of Singapore
+..
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+..
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+..
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+###################################
+How To
+###################################
+
+
+******************************
+Create and Run an Experiment
+******************************
+
+********************************
+Add a Node or Application Config
+********************************
+
+******************************
+Add a Custom Image
+******************************
+
+******************************
+Integrate a New Simulator
+******************************
+
+******************************
+Add a New Interface
+******************************

doc/user/install.rst

+..
+  Copyright 2022 Max Planck Institute for Software Systems, and
+  National University of Singapore
+..
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+..
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+..
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+###################################
+Installing
+###################################
+
+******************************
+System Requirements
+******************************
+
+******************************
+Docker Images
+******************************
+
+******************************
+Building from Source
+******************************
+
+Dependencies
+============
+
+vscode dev container
+--------------------
+
+Building
+==================
\ No newline at end of file

doc/user/parameters.rst → doc/user/orchestration.rst

 ..
-  Copyright 2021 Max Planck Institute for Software Systems, and
+  Copyright 2022 Max Planck Institute for Software Systems, and
   National University of Singapore
 ..
   Permission is hereby granted, free of charge, to any person obtaining
@@ -22,29 +22,53 @@
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ###################################
-Simbricks Orchestration Command-Line Parameters
+SimBricks Orchestration
 ###################################
 
+******************************
+Concepts
+******************************
+
+Experiments
+===========
+
+Runs
+====
+
+Component Simulators
+====================
+
+Node Configuration
+==================
+
+Application Configuration
+-------------------------
+
+
+******************************
+Running Experiments
+******************************
+
+Command Line
+====================
+
 .. code-block:: bash
-   usage: run.py [-h] [--filter PATTERN [PATTERN ...]] [--pickled] [--runs N]
+
+   usage: simbricks-run [-h] [--filter PATTERN [PATTERN ...]] [--pickled] [--runs N]
                [--firstrun N] [--force] [--verbose] [--pcap] [--repo DIR]
                [--workdir DIR] [--outdir DIR] [--cpdir DIR] [--parallel]
                [--cores N] [--mem N] [--slurm] [--slurmdir DIR]
                EXP [EXP ...]
 
-******************************
 Positional arguments
-******************************
+--------------------
 
-   *  ``--EXP``
+   *  ``EXP``
 
       An experiment file to run.
 
-
-
-******************************
 Optional arguments
-******************************
+------------------
 
    *  `` -h, --help``
 
@@ -53,17 +77,20 @@ Optional arguments
    * `` --filter PATTERN [PATTERN ...] ``
       Pattern to match experiment names against
 
+Environment
+-----------
+
 
 ******************************
-Environment
+Images
 ******************************
 
 
 ******************************
-Parallel Runtime
+Distributed Simulations
 ******************************
 
 
 ******************************
-Slurm Runtime
+Slurm
 ******************************

doc/user/quickstart.rst

@@ -22,36 +22,13 @@
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ###################################
-Quick Start
+Getting Started
 ###################################
 
 ******************************
-Introduction
+Overview
 ******************************
 
 ******************************
-Requirements
+Resources
 ******************************
-
-
-******************************
-Building
-******************************
-
-
-
-
-******************************
-Running
-******************************
-
-Before running TAS the following steps are necessary:
-
-   * Use ``--filter`` option specify the experiment
-
-
-.. code-block:: bash
-
-   python3 run.py pyexps/netperf.py --filter nf-gem5-switch-i40e --runs=1 --verbose
-
-

doc/user/troubleshooting.rst

 ..
-  Copyright 2021 Max Planck Institute for Software Systems, and
+  Copyright 2022 Max Planck Institute for Software Systems, and
   National University of Singapore
 ..
   Permission is hereby granted, free of charge, to any person obtaining
@@ -22,5 +22,17 @@
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ###################################
-Simbricks Troubleshooting
+Troubleshooting
 ###################################
+
+************************************
+Is my Simulation Stuck or just Slow?
+************************************
+
+************************************
+Understanding Simulation Performance
+************************************
+
+******************************
+Getting Help
+******************************
\ No newline at end of file