Skip to content

Commit

Permalink
tutorial updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@MarcToussaint
MarcToussaint committed Oct 5, 2023
1 parent 310099a commit 0b57b85
Show file tree
Hide file tree
Showing 96 changed files with 6,316 additions and 10,948 deletions.
6 changes: 3 additions & 3 deletions .gitmodules
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
[submodule "rai-robotModels"]
path = rai-robotModels
url = https://github.com/Jung-Su/rai-robotModels.git
[submodule "rai-python"]
path = rai-python
url = https://github.com/MarcToussaint/rai-python.git
[submodule "rai-tutorials"]
path = rai-tutorials
url = https://github.com/MarcToussaint/rai-tutorials.git
Binary file removed docs/_images/notebooks_1c-komo_36_0.png
View file
Binary file not shown.
Binary file added docs/_images/tutorials_1c-komo_36_0.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 24 additions & 22 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">1. Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="script/script.html">3. Lecture Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="old/old.html">4. Old Material</a></li>
<li class="toctree-l1"><a class="reference internal" href="rai.html">5. rai python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="script/script.html">Lecture Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="old/old.html">Old Material</a></li>
<li class="toctree-l1"><a class="reference internal" href="rai.html">rai python API</a></li>
</ul>

</div>
Expand Down Expand Up @@ -122,8 +122,6 @@ <h2 id="A">A</h2>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.KOMO.addModeSwitch">addModeSwitch() (robotic.ry.KOMO method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.addObject">addObject() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.KOMO.addObjective">addObjective() (robotic.ry.KOMO method)</a>
</li>
Expand All @@ -132,6 +130,8 @@ <h2 id="A">A</h2>
<li><a href="rai.html#robotic.ry.Simulation.addSensor">addSensor() (robotic.ry.Simulation method)</a>
</li>
<li><a href="rai.html#robotic.ry.KOMO.addTimeOptimization">addTimeOptimization() (robotic.ry.KOMO method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.animate">animate() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.ArgWord">ArgWord (class in robotic.ry)</a>
</li>
Expand All @@ -151,18 +151,16 @@ <h2 id="B">B</h2>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.Config.cameraView">cameraView() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.clear">clear() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.KOMO.clearObjectives">clearObjectives() (robotic.ry.KOMO method)</a>
</li>
<li><a href="rai.html#robotic.ry.Simulation.closeGripper">closeGripper() (robotic.ry.Simulation method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.compiled">compiled() (in module robotic.ry)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.Config.computeCollisions">computeCollisions() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config">Config (class in robotic.ry)</a>
Expand Down Expand Up @@ -260,14 +258,12 @@ <h2 id="G">G</h2>
<li><a href="rai.html#robotic.ry.BotOp.getCameraFxypxy">getCameraFxypxy() (robotic.ry.BotOp method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.getCollisions">getCollisions() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.KOMO.getConstraintViolations">getConstraintViolations() (robotic.ry.KOMO method)</a>
</li>
<li><a href="rai.html#robotic.ry.KOMO.getCosts">getCosts() (robotic.ry.KOMO method)</a>
</li>
<li><a href="rai.html#robotic.ry.NLP.getDimension">getDimension() (robotic.ry.NLP method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.getDofIDs">getDofIDs() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.KOMO.getFeatureNames">getFeatureNames() (robotic.ry.KOMO method)</a>
</li>
<li><a href="rai.html#robotic.ry.NLP.getFeatureTypes">getFeatureTypes() (robotic.ry.NLP method)</a>
</li>
Expand Down Expand Up @@ -309,10 +305,10 @@ <h2 id="G">G</h2>
</li>
<li><a href="rai.html#robotic.ry.Config.getJointDimension">getJointDimension() (robotic.ry.Config method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.Config.getJointNames">getJointNames() (robotic.ry.Config method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.Config.getJointState">getJointState() (robotic.ry.Config method)</a>

<ul>
Expand Down Expand Up @@ -448,8 +444,6 @@ <h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.Config.makeObjectsConvex">makeObjectsConvex() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.makeObjectsFree">makeObjectsFree() (robotic.ry.Config method)</a>
</li>
<li>
module
Expand Down Expand Up @@ -549,11 +543,15 @@ <h2 id="R">R</h2>
<li><a href="rai.html#robotic.ry.Config.report">report() (robotic.ry.Config method)</a>

<ul>
<li><a href="rai.html#robotic.ry.KOMO.report">(robotic.ry.KOMO method)</a>
</li>
<li><a href="rai.html#robotic.ry.NLP.report">(robotic.ry.NLP method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.NLP_Solver.reportLagrangeGradients">reportLagrangeGradients() (robotic.ry.NLP_Solver method)</a>
</li>
<li><a href="rai.html#robotic.ry.KOMO.reportProblem">reportProblem() (robotic.ry.KOMO method)</a>
</li>
<li>
Expand Down Expand Up @@ -686,8 +684,6 @@ <h2 id="S">S</h2>
<li><a href="rai.html#robotic.ry.NLP_Solver.setTracing">setTracing() (robotic.ry.NLP_Solver method)</a>
</li>
<li><a href="rai.html#robotic.ry.Simulation">Simulation (class in robotic.ry)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.simulation">simulation() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.SimulationEngine">SimulationEngine (class in robotic.ry)</a>
</li>
Expand Down Expand Up @@ -772,10 +768,16 @@ <h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.BotOp.wait">wait() (robotic.ry.BotOp method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.watchFile">watchFile() (robotic.ry.Config method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rai.html#robotic.ry.Config.watchFile">watchFile() (robotic.ry.Config method)</a>
<li><a href="rai.html#robotic.ry.Config.write">write() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.writeCollada">writeCollada() (robotic.ry.Config method)</a>
</li>
<li><a href="rai.html#robotic.ry.Config.writeURDF">writeURDF() (robotic.ry.Config method)</a>
</li>
</ul></td>
</tr></table>
Expand Down
32 changes: 16 additions & 16 deletions docs/getting_started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>1. Getting Started &mdash; Robotics Python Library documentation</title>
<title>Getting Started &mdash; Robotics Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -20,7 +20,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="2. Tutorials" href="notebooks.html" />
<link rel="next" title="Tutorials" href="tutorials.html" />
<link rel="prev" title="Robotic Control Interface &amp; Manipulation Planning Library" href="index.html" />
</head>

Expand All @@ -45,16 +45,16 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">1. Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#quick-install">1.1. Quick Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="#compiling-from-source-docstrings">1.2. Compiling from Source &amp; Docstrings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installing-the-tutorial-notebooks">1.3. Installing the tutorial notebooks</a></li>
<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>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="script/script.html">3. Lecture Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="old/old.html">4. Old Material</a></li>
<li class="toctree-l1"><a class="reference internal" href="rai.html">5. rai python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="script/script.html">Lecture Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="old/old.html">Old Material</a></li>
<li class="toctree-l1"><a class="reference internal" href="rai.html">rai python API</a></li>
</ul>

</div>
Expand All @@ -71,7 +71,7 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active"><span class="section-number">1. </span>Getting Started</li>
<li class="breadcrumb-item active">Getting Started</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
Expand All @@ -81,9 +81,9 @@
<div itemprop="articleBody">

<section id="getting-started">
<h1><span class="section-number">1. </span>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this heading"></a></h1>
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this heading"></a></h1>
<section id="quick-install">
<h2><span class="section-number">1.1. </span>Quick Install<a class="headerlink" href="#quick-install" title="Permalink to this heading"></a></h2>
<h2>Quick Install<a class="headerlink" href="#quick-install" title="Permalink to this heading"></a></h2>
<p>Install the <code class="docutils literal notranslate"><span class="pre">robotic</span></code> python package. On a standard Ubuntu, the
following should be sufficient:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">liblapack3</span> <span class="n">freeglut3</span> <span class="n">libglew</span><span class="o">-</span><span class="n">dev</span> <span class="n">python3</span> <span class="n">python3</span><span class="o">-</span><span class="n">pip</span>
Expand All @@ -97,7 +97,7 @@ <h2><span class="section-number">1.1. </span>Quick Install<a class="headerlink"
</div>
</section>
<section id="compiling-from-source-docstrings">
<h2><span class="section-number">1.2. </span>Compiling from Source &amp; Docstrings<a class="headerlink" href="#compiling-from-source-docstrings" title="Permalink to this heading"></a></h2>
<h2>Compiling from Source &amp; Docstrings<a class="headerlink" href="#compiling-from-source-docstrings" title="Permalink to this heading"></a></h2>
<ul>
<li><p><strong>Compiling for the real robot:</strong> The <code class="docutils literal notranslate"><span class="pre">robotic</span></code> pip package does
not have the real robot drivers (for the Franka Panda robot)
Expand Down Expand Up @@ -130,7 +130,7 @@ <h2><span class="section-number">1.2. </span>Compiling from Source &amp; Docstri
</ul>
</section>
<section id="installing-the-tutorial-notebooks">
<h2><span class="section-number">1.3. </span>Installing the tutorial notebooks<a class="headerlink" href="#installing-the-tutorial-notebooks" title="Permalink to this heading"></a></h2>
<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>
<span class="n">jupyter</span><span class="o">-</span><span class="n">notebook</span> <span class="o">.</span>
Expand All @@ -148,7 +148,7 @@ <h2><span class="section-number">1.3. </span>Installing the tutorial notebooks<a
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Robotic Control Interface &amp; Manipulation Planning Library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="notebooks.html" class="btn btn-neutral float-right" title="2. Tutorials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="tutorials.html" class="btn btn-neutral float-right" title="Tutorials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Loading

0 comments on commit 0b57b85

Please sign in to comment.