Skip to content

Commit

Permalink
simulation tutorial added
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcToussaint committed Oct 8, 2023
1 parent 0b57b85 commit 40d6ea7
Show file tree
Hide file tree
Showing 14 changed files with 1,514 additions and 233 deletions.
10 changes: 5 additions & 5 deletions docs/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#quick-install">Quick Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="#compiling-from-source-docstrings">Compiling from Source &amp; Docstrings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installing-the-tutorial-notebooks">Installing the tutorial notebooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="#downloading-the-tutorial-notebooks">Downloading the tutorial notebooks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
Expand Down Expand Up @@ -129,10 +129,10 @@ <h2>Compiling from Source &amp; Docstrings<a class="headerlink" href="#compiling
</li>
</ul>
</section>
<section id="installing-the-tutorial-notebooks">
<h2>Installing the tutorial notebooks<a class="headerlink" href="#installing-the-tutorial-notebooks" title="Permalink to this heading"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">MarcToussaint</span><span class="o">/</span><span class="n">rai</span><span class="o">-</span><span class="n">python</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">rai</span><span class="o">-</span><span class="n">python</span><span class="o">/</span><span class="n">notebooks</span>
<section id="downloading-the-tutorial-notebooks">
<h2>Downloading the tutorial notebooks<a class="headerlink" href="#downloading-the-tutorial-notebooks" title="Permalink to this heading"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">MarcToussaint</span><span class="o">/</span><span class="n">rai</span><span class="o">-</span><span class="n">tutorials</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">rai</span><span class="o">-</span><span class="n">tutorials</span>
<span class="n">jupyter</span><span class="o">-</span><span class="n">notebook</span> <span class="o">.</span>
</pre></div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1>Robotic Control Interface &amp; Manipulation Planning Library<a class="heade
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#quick-install">Quick Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#compiling-from-source-docstrings">Compiling from Source &amp; Docstrings</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#installing-the-tutorial-notebooks">Installing the tutorial notebooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#downloading-the-tutorial-notebooks">Downloading the tutorial notebooks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
Expand All @@ -105,6 +105,7 @@ <h1>Robotic Control Interface &amp; Manipulation Planning Library<a class="heade
<li class="toctree-l3"><a class="reference internal" href="tutorials/features.html">Differentiable Features &amp; Collision Evaluation</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/configurationEditing.html">Importing, Editing &amp; Manipulating Configurations</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/komo-reporting.html">KOMO: Reporting &amp; Explaining Convergence</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/simulation.html">Direct Simulation Interface</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#preliminary">Preliminary</a><ul>
Expand All @@ -114,7 +115,6 @@ <h1>Robotic Control Interface &amp; Manipulation Planning Library<a class="heade
<li class="toctree-l3"><a class="reference internal" href="tutorials/komo3-switches-skeletons.html">Advanced: Switches &amp; Skeletons</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/botop3-vision.html">First example to grap images from a webcam</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/botop4-examples.html">Example for grasping in Sim</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/sim1-physics.html">Direct simulation interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/opt1-basics.html">Optimization (NLP formulation and solving)</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/script5-PathFind.html">Path finding example</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/source/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ A standard test is
If tab-autocomplete for jupyter does not work, try `python3 -m pip
install --user jedi==0.17.2`

## Installing the tutorial notebooks
## Downloading the tutorial notebooks

git clone https://github.com/MarcToussaint/rai-python.git
cd rai-python/notebooks
git clone https://github.com/MarcToussaint/rai-tutorials.git
cd rai-tutorials
jupyter-notebook .

If you don't have jupyter installed yet:
Expand Down
8 changes: 4 additions & 4 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ Compiling from Source & Docstrings
If tab-autocomplete for jupyter does not work, try
``python3 -m pip install --user jedi==0.17.2``

Installing the tutorial notebooks
---------------------------------
Downloading the tutorial notebooks
----------------------------------

::

git clone https://github.com/MarcToussaint/rai-python.git
cd rai-python/notebooks
git clone https://github.com/MarcToussaint/rai-tutorials.git
cd rai-tutorials
jupyter-notebook .

If you don’t have jupyter installed yet:
Expand Down
4 changes: 3 additions & 1 deletion docs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Tutorials

All tutorials are jupyter notebooks, downloadable from https://github.com/MarcToussaint/rai-tutorials

For installation instructions, see `Getting Started <getting_started.html>`_.

Basics on Configurations, BotOp & KOMO
======================================

Expand All @@ -28,6 +30,7 @@ There is no special ordering of the following. Each goes deeper in one particula
tutorials/features
tutorials/configurationEditing
tutorials/komo-reporting
tutorials/simulation

Preliminary
===========
Expand All @@ -41,6 +44,5 @@ These are not tested or adapted to the newest code base... They will be updated.
tutorials/core*
tutorials/komo*
tutorials/botop*
tutorials/sim*
tutorials/opt*
tutorials/script5*
5 changes: 3 additions & 2 deletions docs/tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
<li class="toctree-l3"><a class="reference internal" href="tutorials/features.html">Differentiable Features &amp; Collision Evaluation</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/configurationEditing.html">Importing, Editing &amp; Manipulating Configurations</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/komo-reporting.html">KOMO: Reporting &amp; Explaining Convergence</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/simulation.html">Direct Simulation Interface</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#preliminary">Preliminary</a><ul>
Expand All @@ -67,7 +68,6 @@
<li class="toctree-l3"><a class="reference internal" href="tutorials/komo3-switches-skeletons.html">Advanced: Switches &amp; Skeletons</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/botop3-vision.html">First example to grap images from a webcam</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/botop4-examples.html">Example for grasping in Sim</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/sim1-physics.html">Direct simulation interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/opt1-basics.html">Optimization (NLP formulation and solving)</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/script5-PathFind.html">Path finding example</a></li>
</ul>
Expand Down Expand Up @@ -105,6 +105,7 @@
<section id="tutorials">
<h1>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this heading"></a></h1>
<p>All tutorials are jupyter notebooks, downloadable from <a class="reference external" href="https://github.com/MarcToussaint/rai-tutorials">https://github.com/MarcToussaint/rai-tutorials</a></p>
<p>For installation instructions, see <a class="reference external" href="getting_started.html">Getting Started</a>.</p>
<section id="basics-on-configurations-botop-komo">
<h2>Basics on Configurations, BotOp &amp; KOMO<a class="headerlink" href="#basics-on-configurations-botop-komo" title="Permalink to this heading"></a></h2>
<p>This round of 4 tutorials builds on each other and gives a first idea
Expand All @@ -126,6 +127,7 @@ <h2>In Depth<a class="headerlink" href="#in-depth" title="Permalink to this head
<li class="toctree-l1"><a class="reference internal" href="tutorials/features.html">Differentiable Features &amp; Collision Evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/configurationEditing.html">Importing, Editing &amp; Manipulating Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/komo-reporting.html">KOMO: Reporting &amp; Explaining Convergence</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/simulation.html">Direct Simulation Interface</a></li>
</ul>
</div>
</section>
Expand All @@ -140,7 +142,6 @@ <h2>Preliminary<a class="headerlink" href="#preliminary" title="Permalink to thi
<li class="toctree-l1"><a class="reference internal" href="tutorials/komo3-switches-skeletons.html">Advanced: Switches &amp; Skeletons</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/botop3-vision.html">First example to grap images from a webcam</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/botop4-examples.html">Example for grasping in Sim</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/sim1-physics.html">Direct simulation interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/opt1-basics.html">Optimization (NLP formulation and solving)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/script5-PathFind.html">Path finding example</a></li>
</ul>
Expand Down
Loading

0 comments on commit 40d6ea7

Please sign in to comment.