Skip to content

update introduction doc for python #1147

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.

Sign up for GitHub

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 10, 2025
+29 −3
Merged

update introduction doc for python #1147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 29 additions & 3 deletions docs/modules/1_introduction/2_python_for_robotics/python_for_robotics_main.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Python for Robotics
----------------------

Python is used for this `PythonRobotics` project because of the above features
to achieve the purpose of this project described in the :ref:`What is PythonRobotics?`.
This section explains the Python itself and features for Robotics.
A programing language, Python is used for this `PythonRobotics` project
to achieve the purposes of this project described in the :ref:`What is PythonRobotics?`.

This section explains the Python itself and features for science computing Robotics.

Python for general-purpose programming
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -107,3 +108,28 @@ Python code can run on various operating systems (Windows, macOS, Linux), provid
Large Community and Support
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Python has a vast and active community, offering ample resources, tutorials, and support for developers. This is invaluable when tackling challenges in robotics development.

Situations which Python is NOT suitable for Robotics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We explained the advantages of Python for robotics.
However, Python is not always the best choice for robotics development.

These are situations where Python is NOT suitable for robotics:

High-speed real-time control
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Python is an interpreted language, which means it is slower than compiled languages like C++.
This can be a disadvantage when real-time control is required,
such as in high-speed motion control or safety-critical systems.

So, for these applications, we recommend to understand the each algorithm you
needed using this project and implement it in other suitable languages like C++.

Resource-constrained systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Python is a high-level language that requires more memory and processing power
compared to low-level languages.
So, it is difficult to run Python on resource-constrained systems like
microcontrollers or embedded devices.
In such cases, C or C++ is more suitable for these applications.