Skip to content

Commit

Permalink
add note about cloning from the repository
Browse files Browse the repository at this point in the history
  • Loading branch information
RussTedrake committed Dec 31, 2023
1 parent 9fd6a2f commit e81436c
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions book/drake.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,17 +149,24 @@ <h1><a href="index.html" style="text-decoration:none;">Underactuated Robotics</a

<section><h1>Running on your own machine</h1>

<p>As you get more advanced, you will likely want to run (and extend) these examples on your own machine. On <a href="https://drake.mit.edu/installation.html">platforms/configurations that Drake supports</a> (the latest two releases of Mac and Ubuntu using the system default python versions), it should be as simple as running
<p>As you get more advanced, you will likely want to run (and extend) these examples on your own machine. On <a href="https://drake.mit.edu/installation.html">platforms/configurations that Drake supports</a> (the latest two releases of Mac and Ubuntu using the system default python versions). The simplest installation is via <code>pip</code>; I would typically recommend using a virtual environment:
<div style="background:#f0f0f0;">
<div style="display:flex; justify-content:flex-end;"><button style="padding:10; background-color: transparent; border:0" onclick="copy_code_to_clipboard(this)"><svg stroke="currentColor" fill="none" stroke-width="2" viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" class="icon-sm" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2"></path><rect x="8" y="2" width="8" height="4" rx="1" ry="1"></rect></svg>Copy code</button></div>
<pre><code class="bash">pip install underactuated --extra-index-url https://drake-packages.csail.mit.edu/whl/nightly/</code></pre>
</div> In general, I would strongly recommend running <code>pip</code>
commands in a <a
href="https://python-guide-cn.readthedocs.io/en/latest/dev/virtualenvs.html">virtualenv</a>.</p>
<pre><code class="bash">python3 -m venv venv
source venv/bin/activate
pip3 install underactuated --extra-index-url https://drake-packages.csail.mit.edu/whl/nightly/
</code></pre>
</div>
Then you can download notebooks directly from Deepnote and run them locally (or
develop your own notebooks).
</p>

<p></p>The <drake></drake> website also has a number of alternative <a href="https://drake.mit.edu/installation.html">installation options</a>, including precompiled binaries and Docker instances.</p>

<p>You'll likely want to start from the underactuated root directory. Then launch your notebook with:</p>
<p>If you want to download all of the notebooks at once, you can <code>git
clone</code> the <a href="https://github.com/RussTedrake/underactuated">course notes
repository</a>. You'll likely want to start from the repository's root directory.
Then launch your notebook with:</p>

<div style="background:#f0f0f0;">
<div style="display:flex; justify-content:flex-end;"><button style="padding:10; background-color: transparent; border:0" onclick="copy_code_to_clipboard(this)"><svg stroke="currentColor" fill="none" stroke-width="2" viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" class="icon-sm" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2"></path><rect x="8" y="2" width="8" height="4" rx="1" ry="1"></rect></svg>Copy code</button></div>
Expand Down

0 comments on commit e81436c

Please sign in to comment.