-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
101 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.11" | ||
|
||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
configuration: docs/source/conf.py | ||
|
||
# We recommend specifying your dependencies to enable reproducible builds: | ||
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
python: | ||
install: | ||
- requirements: docs/requirements.txt | ||
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
\mainpage MultiBody State Estimation (MBSE) C++ Library | ||
[![MBSE](https://circleci.com/gh/MBDS/multibody-state-estimation.svg?style=svg)](https://circleci.com/gh/MBDS/multibody-state-estimation) | ||
[![Docs](https://readthedocs.org/projects/libmbse/badge/)](https://libmbse.readthedocs.io/) | ||
|
||
# The MultiBody State Estimation (MBSE) C++ library | ||
A library for multibody forward and inverse dynamics, state estimation, and | ||
parameter identification. | ||
|
||
* [C++ API docs](https://libmbse.readthedocs.io/). | ||
* [GitHub repo](https://github.com/MBDS/multibody-state-estimation). | ||
* [Applications](https://libmbse.readthedocs.io/en/latest/pageApps.html). | ||
|
||
Related papers and approaches implemented in this repository: | ||
|
||
## Paradigm #1: Based on factor-graphs | ||
Forward and inverse dynamics, closed kinematic chains constraints solved as | ||
factors in a factor graphs, and more. | ||
|
||
For the theory behinds this work, refer to : | ||
* J.L. Blanco, A. Leanza, G. Reina, "A general framework for modeling and dynamic simulation of multibody systems using factor graphs", 2021. ([ArXiV](https://arxiv.org/abs/2101.02874)) | ||
|
||
![ScreenShot](https://raw.githubusercontent.com/MBDS/multibody-state-estimation/master/doc/source/_static/mbde-fg-screenshot.png) | ||
|
||
## Paradigm #2: Particle filter estimator | ||
A Bayesian filter has been implemented as a particle filter. | ||
Only planar dynamics models have been tested. | ||
For the theory behinds this work, refer to : | ||
* J.L. Blanco, J.L. Torres, A. Gimenez-Fernandez, "Multibody dynamic systems as Bayesian Networks: applications to robust state estimation of mechanisms", Multibody System Dynamics, vol. 34, no. 2, pp. 103-128, 2015. ([Draft PDF](http://ingmec.ual.es/~jlblanco/papers/blanco2015mds_bayesian_networks_DRAFT.pdf), [PDF](http://dx.doi.org/10.1007/s11044-014-9440-9), [BibTeX](http://ingmec.ual.es/aigaion2/index.php/export/publication/289/bibtex)) | ||
|
||
<center> [Open video](https://www.youtube.com/watch?v=7Zru0oiz36g) </center> | ||
![ScreenShot](https://raw.githubusercontent.com/MBDS/multibody-state-estimation/master/doc/source/_static/mbde-pf-screenshot.jpg) | ||
|
||
## Compiling | ||
Dependencies: | ||
* A C++ compiler | ||
* CMake | ||
* SuiteSparse | ||
* [MRPT](https://github.com/mrpt/mrpt/) (>=2.0.0) | ||
* Ubuntu: Use [this PPA](https://launchpad.net/~joseluisblancoc/+archive/ubuntu/mrpt) | ||
* [GTSAM](https://github.com/borglab/gtsam) | ||
* Ubuntu: Use [this PPA](https://launchpad.net/~joseluisblancoc/+archive/ubuntu/gtsam-develop) | ||
|
||
In Ubuntu, install dependencies with: | ||
|
||
sudo apt-get install build-essential cmake libsuitesparse-dev libmrpt-dev libgtsam-dev | ||
|
||
To build: | ||
|
||
mkdir build | ||
cd build | ||
cmake .. | ||
# If you see no errors, go on, otherwise fix them! | ||
make # To compile the library and examples | ||
make test_legacy # To run unit tests | ||
|
||
You should also be able to compile this project under Windows and Visual Studio. | ||
|
||
## Executing | ||
These programs come ready to be launched, and can be found in the `bin` | ||
directory after compiling: | ||
|
||
* `pf_test1`: One of the particle filter estimation experiments showed in the paper. | ||
* `ex_four_bars`: An example of a dynamic simulation of a four bar linkage. | ||
|
||
## Using mbse as a library in a user program | ||
|
||
In your CMake project, add: | ||
|
||
find_package(mbse REQUIRED) | ||
# then in your target: | ||
target_link_libraries(${PROJECT_NAME} mbse::mbse) | ||
|
||
For CMake to find the library, in `cmake-gui` or `ccmake`, set the variable `mbse_DIR` to | ||
`BUILD_DIR/cmake`, where `BUILD_DIR` is the compilation directory where you built MBSE. |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
sphinx>=4.3.0 | ||
sphinx_rtd_theme>=0.5.1 | ||
sphinx_design | ||
sphinxcontrib-bibtex |
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.