MROB: Mobile Robotics library
The Mobile Robotics library (mrob) is our common framework for implementing our robotics research and projects. It includes a core set of functionalities such as geometric transformations (SE3), factor graphs for general state estimation, optimization, 3D point cloud registration and more to come.
The general structure for the algorithms implemented:
- common: common matrix definitions and typedefs.
- geometry: Geometric transformations, mostly Rotations and Rigid Body Transformations in 3D.
- Fgraph: Factor Graphs for state estimation
- PCReg: Point Cloud Registration.
- mrobPy Python bindings (using pybind11) for the above methods.
Python Examples
The library is mainly designed to run in python, that is, algorithms are written in cpp and bind to python for general purpose use. We provide some examples in python_examples for more details.
Dependencies
The present library is meant to be a self-contained library. However, there are few dependencies:
- C++'14
- CMake
- Eigen (included as a submodule)
- pybind11 (included as a submodule)
- python3-distutils
- python3-dev
- Catch2 v2.x branch (included as a submodule)
This is the list of required packages to install: sudo apt install build-essential cmake python3-distutils python3-dev
Repository
Standard github cloning, adding the recursive term for submodules.
git clone --recursive git@github.com:g-ferrer/mrob.git
If there was ever a submodule update (not frequently) the command to use:
git submodule update --recursive
## Installation
If you need to use this library in Python code, you can install it using pip: pip install mrob
Note: If your OS is Windows and you don't have Microsoft Visual C++ Redistributable package installed, then you need to install it additionally. If you are using a 32-bit Python, then install the package for the X86 architecture. If you are using 64-bit Python, then install the package for the X64 architecture. Don't be afraid to install both packages.
License
Apache-2.0 License
