-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
261 lines (244 loc) · 13.4 KB
/
index.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<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>Welcome to Machines-in-Motion’s code base documentation! — Machines-in-Motion 0.0.0 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]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
Machines-in-Motion
</a>
<div class="version">
0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">Welcome to Machines-in-Motion’s code base documentation!</a><ul>
<li><a class="reference internal" href="#readme">Readme</a><ul>
<li><a class="reference internal" href="#visualization-of-the-documentation">Visualization of the documentation:</a><ul>
<li><a class="reference internal" href="#pre-built">Pre-built</a></li>
<li><a class="reference internal" href="#build-the-package-doc-locally">Build the package doc locally</a></li>
</ul>
</li>
<li><a class="reference internal" href="#license-and-copyrights">License and Copyrights</a></li>
</ul>
</li>
<li><a class="reference internal" href="#cool-stuff">Cool Stuff</a></li>
<li><a class="reference internal" href="#list-of-the-package-documentation">List of the package documentation</a></li>
<li><a class="reference internal" href="#copyrights-and-licensing">Copyrights and licensing</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Machines-in-Motion</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to Machines-in-Motion’s code base documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-machines-in-motion-s-code-base-documentation">
<h1>Welcome to Machines-in-Motion’s code base documentation!<a class="headerlink" href="#welcome-to-machines-in-motion-s-code-base-documentation" title="Permalink to this heading">¶</a></h1>
<section id="readme">
<h2>Readme<a class="headerlink" href="#readme" title="Permalink to this heading">¶</a></h2>
<p>This repository <code class="docutils literal notranslate"><span class="pre">machines-in-motion.github.io</span></code> is the entry point for all
the documentation of the repositories listed in the
<a class="reference external" href="https://github.com/machines-in-motion">machines-in-motion</a>
Github organization.</p>
<p>All repositories here are open-sourced packages licensed under the
<code class="docutils literal notranslate"><span class="pre">BSD</span> <span class="pre">3-Clause</span> <span class="pre">license</span></code>. And under the
<code class="docutils literal notranslate"><span class="pre">Copyright</span> <span class="pre">(c)</span> <span class="pre">2019-2020,</span> <span class="pre">New</span> <span class="pre">York</span> <span class="pre">University</span> <span class="pre">and</span> <span class="pre">Max</span> <span class="pre">Planck</span> <span class="pre">Gesellschaft.</span> <span class="pre">All</span> <span class="pre">rights</span> <span class="pre">reserved.</span></code>
Please see the license.txt</p>
<p>This work is done in collaboration between the
<a class="reference external" href="https://is.tuebingen.mpg.de/">Max Planck Institute for Intelligent System</a>
and the <a class="reference external" href="https://engineering.nyu.edu/">New York University</a></p>
<section id="visualization-of-the-documentation">
<h3>Visualization of the documentation:<a class="headerlink" href="#visualization-of-the-documentation" title="Permalink to this heading">¶</a></h3>
<section id="pre-built">
<h4>Pre-built<a class="headerlink" href="#pre-built" title="Permalink to this heading">¶</a></h4>
<p>You can visualized the last built doc in here:
<a class="reference external" href="https://machines-in-motion.github.io/">https://machines-in-motion.github.io/</a></p>
</section>
<section id="build-the-package-doc-locally">
<h4>Build the package doc locally<a class="headerlink" href="#build-the-package-doc-locally" title="Permalink to this heading">¶</a></h4>
<p>How to build the docuementatino locally and how it’s been created is explained here:</p>
<p><a class="reference external" href="https://github.com/machines-in-motion/machines-in-motion.github.io/issues/4">https://github.com/machines-in-motion/machines-in-motion.github.io/issues/4</a></p>
</section>
</section>
<section id="license-and-copyrights">
<h3>License and Copyrights<a class="headerlink" href="#license-and-copyrights" title="Permalink to this heading">¶</a></h3>
<p><em>update the date if it is a new package</em></p>
<p>License BSD-3-Clause
Copyright (c) 2019, New York University and Max Planck Gesellschaft.</p>
</section>
</section>
<section id="cool-stuff">
<h2>Cool Stuff<a class="headerlink" href="#cool-stuff" title="Permalink to this heading">¶</a></h2>
<p><a class="reference external" href="https://www.youtube.com/channel/UCP5iVa-lPN5YgZe6guDQA0Q">Youtube channel of the Machines in Motion group.</a></p>
<p><a class="reference external" href="https://www.youtube.com/channel/UCx32JW2oIrax47Gjq8zNI-w">Youtube channel of the Open Dynamic Robot Initiative.</a></p>
<p>One example of our robot:</p>
<iframe width="425" height="344"
src="https://www.youtube.com/embed/5JqtnulRWIg"
frameborder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen>
</iframe>
</section>
<section id="list-of-the-package-documentation">
<h2>List of the package documentation<a class="headerlink" href="#list-of-the-package-documentation" title="Permalink to this heading">¶</a></h2>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Repositories</p></th>
<th class="head"><p>Documentation</p></th>
<th class="head"><p>Code coverage</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>dg_blmc_robots</p></td>
<td><p><a class="reference external" href="./code_documentation/dg_blmc_robots/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-odd"><td><p>dg_tools</p></td>
<td><p><a class="reference external" href="./code_documentation/dg_tools/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-even"><td><p>dynamic_graph_manager</p></td>
<td><p><a class="reference external" href="./code_documentation/dynamic_graph_manager/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-odd"><td><p>mim_estimation</p></td>
<td><p><a class="reference external" href="./code_documentation/mim_estimation/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-even"><td><p>momentumopt</p></td>
<td><p><a class="reference external" href="./code_documentation/momentumopt/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-odd"><td><p>mpi_cmake_module</p></td>
<td><p><a class="reference external" href="./code_documentation/mpi_cmake_module/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-even"><td><p>mpi_cmake_modules</p></td>
<td><p><a class="reference external" href="./code_documentation/mpi_cmake_modules/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-odd"><td><p>mpi_cpp_tools</p></td>
<td><p><a class="reference external" href="./code_documentation/mpi_cpp_tools/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-even"><td><p>package_template</p></td>
<td><p><a class="reference external" href="./code_documentation/package_template/documentation/index.html">api doc</a></p></td>
<td><p><a class="reference external" href="./code_documentation/package_template/coverage/index.html">coverage</a></p></td>
</tr>
<tr class="row-odd"><td><p>real_time_tools</p></td>
<td><p><a class="reference external" href="./code_documentation/real_time_tools/documentation/index.html">api doc</a></p></td>
<td><p><a class="reference external" href="./code_documentation/real_time_tools/coverage/index.html">coverage</a></p></td>
</tr>
<tr class="row-even"><td><p>shared_memory</p></td>
<td><p><a class="reference external" href="./code_documentation/shared_memory/documentation/index.html">api doc</a></p></td>
<td><p><a class="reference external" href="./code_documentation/shared_memory/coverage/index.html">coverage</a></p></td>
</tr>
<tr class="row-odd"><td><p>solver</p></td>
<td><p><a class="reference external" href="./code_documentation/solver/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-even"><td><p>solver_lqr</p></td>
<td><p><a class="reference external" href="./code_documentation/solver_lqr/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
<tr class="row-odd"><td><p>time_series</p></td>
<td><p><a class="reference external" href="./code_documentation/time_series/documentation/index.html">api doc</a></p></td>
<td><p>Not available.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="copyrights-and-licensing">
<h2>Copyrights and licensing<a class="headerlink" href="#copyrights-and-licensing" title="Permalink to this heading">¶</a></h2>
<p>BSD 3-Clause License</p>
<p>Copyright (c) 2019-2020, New York University and Max Planck Gesellschaft.
All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:</p>
<ol class="arabic simple">
<li><p>Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.</p></li>
<li><p>Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.</p></li>
<li><p>Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.</p></li>
</ol>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright <attribute 'year' of 'datetime.date' objects> New York University and Max Planck Gesellschaft. All rights reserved..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>