mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-13 04:28:04 -05:00
1656cab0d2
* Update Linux_CI.yml * Update MacOS_CI.yml * Update Windows_CI.yml * Delete .lgtm.yml * Update lqr_planner.py * Update lqr_planner.py * Update config.yml * Update environment.yml * Update ruff.toml * Update README.md * Update getting_started_main.rst * Update doc_requirements.txt
86 lines
2.0 KiB
ReStructuredText
86 lines
2.0 KiB
ReStructuredText
.. _`getting started`:
|
|
|
|
Getting Started
|
|
===============
|
|
|
|
What is this?
|
|
-------------
|
|
|
|
This is an Open Source Software (OSS) project: PythonRobotics, which is a Python code collection of robotics algorithms.
|
|
|
|
The focus of the project is on autonomous navigation, and the goal is for beginners in robotics to understand the basic ideas behind each algorithm.
|
|
|
|
In this project, the algorithms which are practical and widely used in both academia and industry are selected.
|
|
|
|
Each sample code is written in Python3 and only depends on some standard modules for readability and ease of use.
|
|
|
|
It includes intuitive animations to understand the behavior of the simulation.
|
|
|
|
|
|
See this paper for more details:
|
|
|
|
- PythonRobotics: a Python code collection of robotics algorithms: https://arxiv.org/abs/1808.10703
|
|
|
|
.. _`Requirements`:
|
|
|
|
Requirements
|
|
-------------
|
|
|
|
- `Python 3.12.x`_
|
|
- `NumPy`_
|
|
- `SciPy`_
|
|
- `Matplotlib`_
|
|
- `cvxpy`_
|
|
|
|
For development:
|
|
|
|
- `pytest`_ (for unit tests)
|
|
- `pytest-xdist`_ (for parallel unit tests)
|
|
- `mypy`_ (for type check)
|
|
- `sphinx`_ (for document generation)
|
|
- `ruff`_ (for code style check)
|
|
|
|
.. _`Python 3.11.x`: https://www.python.org/
|
|
.. _`NumPy`: https://numpy.org/
|
|
.. _`SciPy`: https://scipy.org/
|
|
.. _`Matplotlib`: https://matplotlib.org/
|
|
.. _`cvxpy`: https://www.cvxpy.org/
|
|
.. _`pytest`: https://docs.pytest.org/en/latest/
|
|
.. _`pytest-xdist`: https://github.com/pytest-dev/pytest-xdist
|
|
.. _`mypy`: https://mypy-lang.org/
|
|
.. _`sphinx`: https://www.sphinx-doc.org/en/master/index.html
|
|
.. _`ruff`: https://github.com/charliermarsh/ruff
|
|
|
|
|
|
How to use
|
|
----------
|
|
|
|
1. Clone this repo and go into dir.
|
|
|
|
.. code-block::
|
|
|
|
>$ git clone https://github.com/AtsushiSakai/PythonRobotics.git
|
|
|
|
>$ cd PythonRobotics
|
|
|
|
|
|
2. Install the required libraries.
|
|
|
|
using conda :
|
|
|
|
.. code-block::
|
|
|
|
>$ conda env create -f requirements/environment.yml
|
|
|
|
using pip :
|
|
|
|
.. code-block::
|
|
|
|
>$ pip install -r requirements/requirements.txt
|
|
|
|
|
|
3. Execute python script in each directory.
|
|
|
|
4. Add star to this repo if you like it 😃.
|
|
|