-
Notifications
You must be signed in to change notification settings - Fork 6
/
installation.html
368 lines (302 loc) · 13.2 KB
/
installation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta name="msapplication-config" content="/browserconfig.xml"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta charset="utf-8"/>
<link rel="apple-touch-icon" type="image/png" href="/apple-touch-icon.png"/>
<link rel="manifest" type="application/manifest+json" href="/site.webmanifest"/>
<link rel="mask-icon" type="image/svg+xml" href="/mask-icon.svg" color="#990000"/>
<link rel="shortcut icon" type="image/png" href="/favicon.png"/>
<title>Drake: Installation and Quickstart</title>
<meta
name="description"
content="Drake ("dragon" in Middle English) is a C++ toolbox started by the Robot
Locomotion Group at the MIT Computer Science and Artificial Intelligence
Lab (CSAIL). The development team has now grown significantly, with core
development led by the Toyota Research Institute. It is a collection of
tools for analyzing the dynamics of our robots and building control
systems for them, with a heavy emphasis on optimization-based design/
analysis.
"/>
<!--
The "Work Sans" font is licensed under the SIL Open Font License (OFL). For
more information, see:
- https://fonts.google.com/specimen/Work+Sans?preview.text_type=custom#about
- https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL
-->
<link href="https://fonts.googleapis.com/css2?family=Space+Mono:wght@400;700&family=Work+Sans:wght@300;400;600;700;800&display=swap" rel="stylesheet"/>
<link rel="stylesheet" href="/third_party/github-styling/github-markdown.css"/>
<link rel="stylesheet" href="/third_party/dracula/syntax.css"/>
<link rel="stylesheet" href="/third_party/pylons/pylons.css"/>
<link rel="stylesheet" href="/assets/css/main.css"/>
</head>
<body>
<header class="site-header">
<div class="site-header-inner contain">
<a href="/" class="drake-logo">
<img src="/images/drake-logo-white.svg">
</a>
<div class="menu-mobile-toggle">
<span></span>
</div>
<nav class="site-menu">
<ul>
<li class="site-menu-item site-menu-item-main">
<a href="/" class="site-menu-item">Home</a>
</li>
<li class="site-menu-item site-menu-item-main">
<a href="/installation.html" class="site-menu-item">Installation</a>
</li>
<li class="site-menu-item site-menu-item-main">
<a href="/gallery.html" class="site-menu-item">Gallery</a>
</li>
<li class="site-menu-item site-menu-item-main">
API Documentation
<div class="sub">
<a href="/doxygen_cxx/index.html" class="site-menu-item">C++</a>
<a href="/pydrake/index.html" class="site-menu-item">Python</a>
</div>
</li>
<li class="site-menu-item site-menu-item-main">
Resources
<div class="sub">
<a href="/getting_help.html" class="site-menu-item">Getting Help</a>
<a href="https://deepnote.com/workspace/Drake-0b3b2c53-a7ad-441b-80f8-bf8350752305/project/Tutorials-2b4fc509-aef2-417d-a40d-6071dfed9199/%2Findex.ipynb" class="site-menu-item">Tutorials</a>
<a href="/python_bindings.html" class="site-menu-item">Python Bindings</a>
<a href="/developers.html" class="site-menu-item">For Developers</a>
<a href="/credits.html" class="site-menu-item">Credits</a>
</div>
</li>
<li class="search">
<div class="search-icon">
<!-- This is an inline SVG image of a magnifying glass. -->
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 374.9 374.84">
<path d="M235 270a148.74 148.74 0 1 1 35-35l97.74 97.74a24.37 24.37 0 0 1 0 34.58l-.4.4a24.47 24.47 0 0 1-34.58 0L235 270Zm-86.22-7.47A113.75 113.75 0 1 0 35 148.75 113.75 113.75 0 0 0 148.75 262.5Z"/>
</svg>
</div>
<div class="search-bar">
<form id="search_form" action="https://google.com/search" method="get">
<input type="text" name="q" placeholder="Search all of Drake…" />
<input type="hidden" name="q" value="site:drake.mit.edu OR site:underactuated.csail.mit.edu OR site:manipulation.csail.mit.edu" />
</form>
<div class="search-close">
<!-- This is an inline SVG image of an "X". -->
<svg height="20" width="20" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 373.61 373.57">
<path d="M219.71 186.77 366.71 40a23.43 23.43 0 1 0-33.13-33.13l-146.77 147-146.77-147A23.43 23.43 0 0 0 6.9 40l147 146.77-147 146.77a23.43 23.43 0 1 0 33.14 33.13l146.77-147 146.77 147a23.43 23.43 0 1 0 33.13-33.13Z"/>
</svg>
</div>
</div>
<ul id="results-container"></ul>
</li>
<li class="github-link">
<a href="https://github.com/RobotLocomotion/drake" class="site-menu-item">GitHub <img src="/third_party/images/GitHub-Mark-Light-64px.png" /></a>
</li>
</ul>
</nav>
</div>
</header>
<div class="page">
<div class="content">
<div class="drake-page">
<header class="drake-page-header">
<div class="contain">
<h1>Installation and Quickstart</h1>
</div>
</header>
<section class="padding">
<div class="contain">
<article class="markdown-body">
<h1 id="previewing">Previewing</h1>
<p>Before installing, you can preview Drake online using our interactive Python
notebooks. See the <a href="/index.html#tutorials">Tutorials</a> page for details.</p>
<h1 id="installation">Installation</h1>
<h2 id="supported-configurations">Supported Configurations</h2>
<!-- The macOS python version below should match what's listed in both the root
CMakeLists.txt and tools/workspace/python/repository.bzl. When any Python
version changes, also be sure to grep the full body of documentation to find
any other citations to it (e.g., in PYTHONPATH). -->
<p>The following table shows the configurations and platforms that Drake
officially supports:</p>
<table>
<thead>
<tr>
<th>Operating System ⁽¹⁾</th>
<th>Architecture</th>
<th>Python ⁽²⁾</th>
<th>End of life ⁽⁴⁾</th>
</tr>
</thead>
<tbody>
<tr>
<td>Ubuntu 22.04 LTS (Jammy Jellyfish)</td>
<td>x86_64</td>
<td>3.10 ⁽³⁾</td>
<td>March 2026</td>
</tr>
<tr>
<td>Ubuntu 24.04 LTS (Noble Numbat)</td>
<td>x86_64</td>
<td>3.12 ⁽³⁾</td>
<td>March 2028</td>
</tr>
<tr>
<td>macOS Sonoma (14)</td>
<td>arm64</td>
<td>3.12 ⁽³⁾</td>
<td>October 2025</td>
</tr>
<tr>
<td>macOS Sequoia (15)</td>
<td>arm64</td>
<td>3.12 ⁽³⁾</td>
<td>October 2026</td>
</tr>
</tbody>
</table>
<p>“Official support” means that we have Continuous Integration test coverage to
notice regressions, so if it doesn’t work for you then please file a bug report.</p>
<p>Unofficially, Drake is also likely to be compatible with newer versions of
Ubuntu or macOS than what are listed, or with Ubuntu 22.04 running on arm64, or
with other versions of Python. However, these are not supported so if it doesn’t
work for you then please file a pull request with the fix, not a bug report.</p>
<p>⁽¹⁾ Drake features that perform image rendering (e.g., camera simulation)
require a working display server. Most personal computers will have this
already built in, but some cloud or docker environments may require extra
setup steps.</p>
<p>⁽²⁾ CPython is the only Python implementation supported.
Drake is not tested regularly with Anaconda, so if you are using Anaconda you
may experience compatibility hiccups; when asking for help, be sure to mention
that Conda is involved.</p>
<p>⁽³⁾ The Python version shown in the table is supported for all installation
channels. Additionally, when installing via <code class="language-plaintext highlighter-rouge">pip</code>
on Ubuntu Python versions 3.10 through 3.12 (inclusive) are supported and
on macOS Python versions 3.11 through 3.12 (inclusive) are supported.
Refer to <a href="/stable.html#os-support">OS Support</a> for details on our “end of life”
timeline for changing which Python versions are supported.</p>
<p>⁽⁴⁾ These end-of-life dates are estimates.
Refer to <a href="/stable.html#os-support">OS Support</a> for details.</p>
<p>Additionally, if you are compiling your own C++ code against Drake’s C++ code
and are using Drake’s pre-compiled binaries, then you must use the same
compiler as our releases:</p>
<table>
<thead>
<tr>
<th>Operating System</th>
<th>C/C++ Compiler</th>
<th>Std</th>
</tr>
</thead>
<tbody>
<tr>
<td>Ubuntu 22.04 LTS (Jammy Jellyfish)</td>
<td>GCC 11</td>
<td>C++20</td>
</tr>
<tr>
<td>Ubuntu 24.04 LTS (Noble Numbat)</td>
<td>GCC 13</td>
<td>C++20</td>
</tr>
<tr>
<td>macOS Sonoma (14)</td>
<td>Apple LLVM 16 (Xcode 16)</td>
<td>C++20</td>
</tr>
<tr>
<td>macOS Sequoia (15)</td>
<td>Apple LLVM 16 (Xcode 16)</td>
<td>C++20</td>
</tr>
</tbody>
</table>
<h2 id="available-versions">Available Versions</h2>
<p>Drake publishes stable releases approximately once a month, and also
offers nightly builds on an ongoing basis.</p>
<p>For new users, we recommend using the stable releases. New releases
will be announced on Drake’s GitHub
<a href="https://github.com/RobotLocomotion/drake/releases">releases</a> page and
documented in Drake’s <a href="/release_notes/release_notes.html">Release Notes</a>.
Refer to our <a href="/stable.html">Drake Stability Guidelines</a> for our policy
on API changes.</p>
<p>Experienced users who want access to the latest features may use the
nightly builds.</p>
<h2 id="choose-an-installation-method">Choose an Installation Method</h2>
<p>The following table shows the installation methods available for Drake’s
pre-compiled binaries, per the supported platforms and release versions.</p>
<p>The pip packages only support using Drake via Python.
All other packages support both C++ and/or Python.</p>
<table>
<thead>
<tr>
<th> </th>
<th>Ubuntu</th>
<th>macOS</th>
</tr>
</thead>
<tbody>
<tr>
<td>Using pip</td>
<td><a href="/pip.html#stable-releases">Stable</a> or <a href="/pip.html#nightly-releases">Nightly</a></td>
<td><a href="/pip.html#stable-releases">Stable</a> or <a href="/pip.html#nightly-releases">Nightly</a></td>
</tr>
<tr>
<td>Using apt (deb)</td>
<td><a href="/apt.html#stable-releases">Stable</a> or <a href="/apt.html#nightly-releases">Nightly</a></td>
<td> </td>
</tr>
<tr>
<td>Using tar.gz download</td>
<td><a href="/from_binary.html#stable-releases">Stable</a> or <a href="/from_binary.html#nightly-releases">Nightly</a></td>
<td><a href="/from_binary.html#stable-releases">Stable</a> or <a href="/from_binary.html#nightly-releases">Nightly</a></td>
</tr>
<tr>
<td>Using Docker Hub</td>
<td><a href="/docker.html#stable-releases">Stable</a> or <a href="/docker.html#nightly-releases">Nightly</a></td>
<td><a href="/docker.html#stable-releases">Stable</a> or <a href="/docker.html#nightly-releases">Nightly</a></td>
</tr>
</tbody>
</table>
<p>Alternatively, you can skip the pre-compiled binaries and build Drake
following the instructions in <a href="/from_source.html">Source Installation</a>.</p>
<p>Drake’s binary releases do not support the Gurobi solver.
To use Gurobi, you must build Drake from source.</p>
<h1 id="quickstart">Quickstart</h1>
<p>For Python, refer to
<a href="/python_bindings.html#using-the-python-bindings">Using the Python Bindings</a>.</p>
<p>For C++, refer to either the
<a href="https://github.com/RobotLocomotion/drake-external-examples/tree/main/drake_cmake_installed_apt">example CMake project for apt (deb)</a>
or the
<a href="https://github.com/RobotLocomotion/drake-external-examples/tree/main/drake_cmake_installed">example CMake project for tar.gz download</a>.</p>
</article>
</div>
</section>
</div>
<footer class="site-footer padding">
<div class="contain">
<a href="/" class="drake-logo">
<img src="/images/drake-logo.svg">
</a>
<div class="footer-menu">
<ul>
<li>
<a href="/doxygen_cxx/index.html" class="site-menu-item">C++</a>
</li>
<li>
<a href="/pydrake/index.html" class="site-menu-item">Python</a>
</li>
<li class="github-link">
<a href="https://github.com/RobotLocomotion/drake" class="site-menu-item">GitHub <img src="/third_party/images/GitHub-Mark-64px.png" /></a>
</li>
</ul>
</div>
</div>
<!-- TODO(eric.cousineau): Consider placing copyright here. -->
</footer>
</div>
</div>
<script src="/assets/js/mobile.js"></script>
<!-- Search -->
<script src="/assets/js/search.js"></script>
</body>
</html>