added images to user guide

DynaDojo · Jan 2, 2024 · ceb9bae · ceb9bae
1 parent 3ff7c03
commit ceb9bae
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 4 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/user-guide/index.doctree b/docs/build/doctrees/user-guide/index.doctree
diff --git a/docs/build/html/_sources/user-guide/index.rst.txt b/docs/build/html/_sources/user-guide/index.rst.txt
@@ -2,11 +2,21 @@
 User Guide
 =================
 
+.. figure:: ../_static/roles.png
+   :align: center
 
 Systems
 ========
 DynaDojo systems represent dynamical systems. They generate datasets of trajectories for DynaDojo algorithms to train and predict.
 
+.. figure:: ../_static/systems.png
+   :align: center
+
+They are also highly tunable.
+
+.. figure:: ../_static/params.png
+   :align: center
+
 
 Algorithms
 ===========
@@ -16,4 +26,7 @@ DynaDojo algorithms train on data generated from DynaDojo systems.
 Challenges
 ===========
 
-DynaDojo challenges benchmark how DynaDojo algorithms perform on DynaDojo systems.
+DynaDojo challenges benchmark how DynaDojo algorithms perform on DynaDojo systems. Developers can implement their own challenges or use our off-the-shelf challenges to benchmark a range of metrics.
+
+.. figure:: ../_static/cube.png
+   :align: center
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/build/html/user-guide/index.html b/docs/build/html/user-guide/index.html
@@ -416,17 +416,30 @@
         <article role="main">
           <section id="user-guide">
 <h1>User Guide<a class="headerlink" href="#user-guide" title="Link to this heading">#</a></h1>
+<figure class="align-center">
+<img alt="../_images/roles.png" src="../_images/roles.png" />
+</figure>
 <section id="systems">
 <h2>Systems<a class="headerlink" href="#systems" title="Link to this heading">#</a></h2>
 <p>DynaDojo systems represent dynamical systems. They generate datasets of trajectories for DynaDojo algorithms to train and predict.</p>
+<figure class="align-center">
+<img alt="../_images/systems.png" src="../_images/systems.png" />
+</figure>
+<p>They are also highly tunable.</p>
+<figure class="align-center">
+<img alt="../_images/params.png" src="../_images/params.png" />
+</figure>
 </section>
 <section id="algorithms">
 <h2>Algorithms<a class="headerlink" href="#algorithms" title="Link to this heading">#</a></h2>
 <p>DynaDojo algorithms train on data generated from DynaDojo systems.</p>
 </section>
 <section id="challenges">
 <h2>Challenges<a class="headerlink" href="#challenges" title="Link to this heading">#</a></h2>
-<p>DynaDojo challenges benchmark how DynaDojo algorithms perform on DynaDojo systems.</p>
+<p>DynaDojo challenges benchmark how DynaDojo algorithms perform on DynaDojo systems. Developers can implement their own challenges or use our off-the-shelf challenges to benchmark a range of metrics.</p>
+<figure class="align-center">
+<img alt="../_images/cube.png" src="../_images/cube.png" />
+</figure>
 </section>
 </section>
 

diff --git a/docs/source/_static/cube.png b/docs/source/_static/cube.png
diff --git a/docs/source/_static/params.png b/docs/source/_static/params.png
diff --git a/docs/source/_static/roles.png b/docs/source/_static/roles.png
diff --git a/docs/source/_static/systems.png b/docs/source/_static/systems.png
diff --git a/docs/source/user-guide/index.rst b/docs/source/user-guide/index.rst
@@ -2,11 +2,21 @@
 User Guide
 =================
 
+.. figure:: ../_static/roles.png
+   :align: center
 
 Systems
 ========
 DynaDojo systems represent dynamical systems. They generate datasets of trajectories for DynaDojo algorithms to train and predict.
 
+.. figure:: ../_static/systems.png
+   :align: center
+
+They are also highly tunable.
+
+.. figure:: ../_static/params.png
+   :align: center
+
 
 Algorithms
 ===========
@@ -16,4 +26,7 @@ DynaDojo algorithms train on data generated from DynaDojo systems.
 Challenges
 ===========
 
-DynaDojo challenges benchmark how DynaDojo algorithms perform on DynaDojo systems.
+DynaDojo challenges benchmark how DynaDojo algorithms perform on DynaDojo systems. Developers can implement their own challenges or use our off-the-shelf challenges to benchmark a range of metrics.
+
+.. figure:: ../_static/cube.png
+   :align: center