Skip to content

fix: update robotics documentation for clarity and correct terminology #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,10 @@ See this documentation

- [Getting Started — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/getting_started.html#what-is-pythonrobotics)

or this Youtube video:

- [PythonRobotics project audio overview](https://www.youtube.com/watch?v=uMeRnNoJAfU)

or this paper for more details:

- [\[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))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,12 @@ the following additional libraries are required.
For instructions on installing the above libraries, please refer to
this section ":ref:`How to run sample codes`".

Audio overview of this project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For an audio overview of this project, please refer to this `YouTube video`_.

.. _`YouTube video`: https://www.youtube.com/watch?v=uMeRnNoJAfU

Arxiv paper
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,5 +103,5 @@ Robotics consists of several essential components:
#. Power Supply – Provides energy to run the robot (e.g., Batteries, Solar power).
#. Software & Algorithms – Allow the robot to function and make intelligent decisions (e.g., ROS, Machine learning models, Localization, Mapping, Path planning, Control).

This project, PythonRobotics, focuses on the software and algorithms part of robotics.
This project, `PythonRobotics`, focuses on the software and algorithms part of robotics.
If you are interested in `Sensors` hardware, you can check :ref:`Internal Sensors for Robotics`_ or :ref:`External Sensors for Robotics`_.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Core Concept
* Maintain global path connectivity.

Bubble Representation
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~
- **Definition**: A local free-space region around configuration :math:`b`:

.. math::
Expand Down Expand Up @@ -56,7 +56,7 @@ External Repulsion Force
\frac{\partial \rho}{\partial x} \approx \frac{\rho(b_i + h) - \rho(b_i - h)}{2h}.

Dynamic Path Maintenance
~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~
1. **Node Update**:

.. math::
Expand All @@ -68,6 +68,7 @@ Dynamic Path Maintenance
- Insert new nodes if adjacent nodes are too far apart
- Remove redundant nodes if adjacent nodes are too close

Ref:
References
~~~~~~~~~~~~~~~~~~~~~~~

- `Elastic Bands: Connecting Path Planning and Control <http://www8.cs.umu.se/research/ifor/dl/Control/elastic%20bands.pdf>`__