.. PythonRobotics documentation master file, created by
   sphinx-quickstart on Sat Sep 15 13:15:55 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PythonRobotics's documentation!
==========================================

Python codes for robotics algorithm. The project is on `GitHub`_.

This is a Python code collection of robotics algorithms, especially for autonomous navigation.

Features:

1. Easy to read for understanding each algorithm's basic idea.

2. Widely used and practical algorithms are selected.

3. Minimum dependency.

See this paper for more details:

-  `[1808.10703] PythonRobotics: a Python code collection of robotics
   algorithms`_ (`BibTeX`_)


.. _`[1808.10703] PythonRobotics: a Python code collection of robotics algorithms`: https://arxiv.org/abs/1808.10703
.. _BibTeX: https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib
.. _GitHub: https://github.com/AtsushiSakai/PythonRobotics


.. toctree::
   :maxdepth: 2
   :caption: Guide

   getting_started
   modules/introduction
   modules/localization
   modules/mapping
   modules/slam
   modules/path_planning
   modules/path_tracking
   modules/arm_navigation
   modules/aerial_navigation
   modules/appendix


Indices and tables
==================

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