@@ -8,7 +8,7 @@ These codes are developed under `MIT license`_ and on `GitHub`_.
8
8
9
9
This project has three main philosophies below:
10
10
11
- 1. Easy to understand each algorithm's basic idea.
11
+ Philosophy 1. Easy to understand each algorithm's basic idea.
12
12
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13
13
14
14
The goal is for beginners in robotics to understand the basic ideas behind each algorithm.
@@ -31,17 +31,26 @@ path planning in a highway scenario for autonomous vehicle.
31
31
.. image :: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/FrenetOptimalTrajectory/high_speed_and_velocity_keeping_frenet_path.gif
32
32
33
33
This animation is a gif file and is created using the `Matplotlib `_ library.
34
- All animaion gif files are stored in the `PythonRoboticsGifs `_ repository and
35
- all animation movies are uploaded to this `YouTube channel `_.
34
+ All animation gif files are stored in the `PythonRoboticsGifs `_ repository and
35
+ all animation movies are also uploaded to this `YouTube channel `_.
36
36
37
37
PythonRobotics also provides a textbook that explains the basic ideas of each algorithm.
38
+ The PythonRobotics textbook allows you to learn fundamental algorithms used in
39
+ robotics with minimal mathematical formulas and textual explanations,
40
+ based on PythonRobotics’ sample codes and animations.
41
+ The contents of this document, like the code, are managed in the PythonRobotics
42
+ `GitHub `_ repository and converted into HTML-based online documents using `Sphinx `_,
43
+ which is a Python-based documentation builder.
44
+ Please refer to this section ":ref: `How to read this textbook `" for information on
45
+ how to read this document for learning.
46
+
38
47
39
48
.. _`Python` : https://www.python.org/
40
49
.. _`PythonRoboticsGifs` : https://github.com/AtsushiSakai/PythonRoboticsGifs
41
50
.. _`YouTube channel` : https://youtube.com/playlist?list=PL12URV8HFpCozuz0SDxke6b2ae5UZvIwa&si=AH2fNPPYufPtK20S
42
51
43
52
44
- 2. Widely used and practical algorithms are selected.
53
+ Philosophy 2. Widely used and practical algorithms are selected.
45
54
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46
55
47
56
The second philosophy is that implemented algorithms have to be practical
@@ -53,7 +62,7 @@ dynamic programming based approaches and sampling based approaches for path plan
53
62
and optimal control based approach for path tracking.
54
63
These algorithms are implemented in this project.
55
64
56
- 3. Minimum dependency.
65
+ Philosophy 3. Minimum dependency.
57
66
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
67
59
68
Each sample code is written in Python3 and only depends on some standard
@@ -84,7 +93,7 @@ For development:
84
93
- `pytest `_ (for unit tests)
85
94
- `pytest-xdist `_ (for parallel unit tests)
86
95
- `mypy `_ (for type check)
87
- - `sphinx `_ (for document generation)
96
+ - `Sphinx `_ (for document generation)
88
97
- `ruff `_ (for code style check)
89
98
90
99
.. _`Python 3.12.x` : https://www.python.org/
@@ -95,6 +104,6 @@ For development:
95
104
.. _`pytest` : https://docs.pytest.org/en/latest/
96
105
.. _`pytest-xdist` : https://github.com/pytest-dev/pytest-xdist
97
106
.. _`mypy` : https://mypy-lang.org/
98
- .. _`sphinx ` : https://www.sphinx-doc.org/en/master/index.html
107
+ .. _`Sphinx ` : https://www.sphinx-doc.org/en/master/index.html
99
108
.. _`ruff` : https://github.com/astral-sh/ruff
100
109
0 commit comments