============
MRPT
============

.. toctree::
  :maxdepth: 2
  :hidden:
  :caption: Get it

  download-mrpt
  compiling
  license
  page_changelog
  authors

.. toctree::
  :maxdepth: 2
  :hidden:
  :caption: Learn it

  tutorials
  applications
  examples
  supported-sensors
  unit_testing
  children-projects

.. toctree::
  :maxdepth: 2
  :hidden:
  :caption: Advanced

  modules
  contributing
  doxygen-index
  Docs for other versions <https://docs.mrpt.org/reference/>

.. image:: https://mrpt.github.io/imgs/mrpt-videos-mix2.gif
   :alt: MRPT demo usages
   :align: right

About
---------
Mobile Robot Programming Toolkit (MRPT) provides developers with
portable and well-tested `applications <applications.html>`_ and
`libraries <modules.html>`_ covering data structures and algorithms
employed in common robotics research areas.

It is open source, released under the `3-clause BSD license <license.html>`_.


Get it
--------

- :ref:`downloadmrpt`: for installing for Linux or Windows.
- :ref:`compiling`: to build from sources.

Where to start
------------------

- C++ API reference: :ref:`modules`.
- Dozens of examples: :ref:`examples`.
- GitHub repository: https://github.com/MRPT/mrpt
- Ask questions at the mail list `mrpt-users@googlegroups.com <https://groups.google.com/forum/#!forum/mrpt-users>`_ or at `stackoverflow <https://stackoverflow.com/search?q=mrpt>`_  using the tag `mrpt`.
- ROS packages: `mrpt_navigation <https://wiki.ros.org/mrpt_navigation>`_, `mrpt_slam <https://wiki.ros.org/mrpt_slam>`_, `mrpt_sensors <https://wiki.ros.org/mrpt_sensors>`_.
- `Bindings documentation <https://github.com/MRPT/mrpt/wiki>`_ (Python, Matlab)
- Example configuration files for  MRPT applications can be found at:
  `MRPT/share/mrpt/config_files <https://github.com/MRPT/mrpt/tree/master/share/mrpt/config_files>`_.
- Some sample datasets are stored in:
  `MRPT/share/mrpt/datasets <https://github.com/MRPT/mrpt/tree/master/share/mrpt/datasets>`_.
  A more complete dataset repository is `available online <https://www.mrpt.org/robotics_datasets>`_.
- :ref:`contributing` your bug fixes, new features, etc.


You may also want to see
---------------------------

- The `ChangeLog <page_changelog.html>`_ for this version.
- Performance benchmarks: Extensive performance tests are automated by means of the application `mrpt-performance`, which was moved (2018)
  to `its own Git repository <https://github.com/MRPT/mrpt-performance-tests>`_. The results on different platforms, as well as a comparison between different
  compilers and platforms are published in https://performance.mrpt.org/
- `Porting your code from MRPT 1.x to MRPT 2.x <porting_mrpt2.html>`_
- MRPT is used in the `MOLA modular SLAM framework <https://github.com/MOLAorg/mola/>`_.

Indices and tables
---------------------------

* :ref:`genindex`
* :ref:`modindex`
