mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-13 14:48:02 -05:00
50 lines
1.1 KiB
ReStructuredText
50 lines
1.1 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
|
|
-------------
|
|
|
|
- Python 3.6.x
|
|
- numpy
|
|
- scipy
|
|
- matplotlib
|
|
- pandas
|
|
- `cvxpy`_
|
|
|
|
.. _cvxpy: http://www.cvxpy.org/en/latest/
|
|
|
|
|
|
How to use
|
|
----------
|
|
|
|
1. Install the required libraries. You can use environment.yml with
|
|
conda command.
|
|
|
|
2. Clone this repo.
|
|
|
|
3. Execute python script in each directory.
|
|
|
|
4. Add star to this repo if you like it 😃.
|
|
|