Welcome to Machines-in-Motion’s code base documentation!¶

Readme¶

This repository machines-in-motion.github.io is the entry point for all the documentation of the repositories listed in the machines-in-motion Github organization.

All repositories here are open-sourced packages licensed under the BSD 3-Clause license. And under the Copyright (c) 2019-2020, New York University and Max Planck Gesellschaft. All rights reserved. Please see the license.txt

This work is done in collaboration between the Max Planck Institute for Intelligent System and the New York University

Visualization of the documentation:¶

Pre-built¶

You can visualized the last built doc in here: https://machines-in-motion.github.io/

Build the package doc locally¶

How to build the docuementatino locally and how it’s been created is explained here:

https://github.com/machines-in-motion/machines-in-motion.github.io/issues/4

License and Copyrights¶

update the date if it is a new package

Cool Stuff¶

Youtube channel of the Machines in Motion group.

Youtube channel of the Open Dynamic Robot Initiative.

One example of our robot:

List of the package documentation¶

Repositories	Documentation	Code coverage
dg_blmc_robots	api doc	Not available.
dg_tools	api doc	Not available.
dynamic_graph_manager	api doc	Not available.
mim_estimation	api doc	Not available.
momentumopt	api doc	Not available.
mpi_cmake_module	api doc	Not available.
mpi_cmake_modules	api doc	Not available.
mpi_cpp_tools	api doc	Not available.
package_template	api doc	coverage
real_time_tools	api doc	coverage
shared_memory	api doc	coverage
solver	api doc	Not available.
solver_lqr	api doc	Not available.
time_series	api doc	Not available.

Copyrights and licensing¶

BSD 3-Clause License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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.

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.