@@ -71,11 +71,13 @@ Python codes for robotics algorithm.
7171 * [ Contribution] ( #contribution )
7272 * [ Citing] ( #citing )
7373 * [ Support] ( #support )
74+ * [ Sponsors] ( #Sponsors )
75+ * [ JetBrains] ( #JetBrains )
7476 * [ Authors] ( #authors )
7577
7678# What is this?
7779
78- This is a Python code collection of robotics algorithms, especially for autonomous navigation .
80+ This is a Python code collection of robotics algorithms.
7981
8082Features:
8183
@@ -92,6 +94,8 @@ See this paper for more details:
9294
9395# Requirements
9496
97+ For running each sample code:
98+
9599- Python 3.9.x
96100
97101- numpy
@@ -103,8 +107,18 @@ See this paper for more details:
103107- pandas
104108
105109- [ cvxpy] ( https://www.cvxpy.org/index.html )
110+
111+ For development:
112+
113+ - pytest (for unit tests)
114+
115+ - pytest-xdist (for parallel unit tests)
116+
117+ - mypy (for type check)
106118
107- - pytest (only for unit tests)
119+ - Sphinx (for document generation)
120+
121+ - pycodestyle (for code style check)
108122
109123# Documentation
110124
@@ -123,11 +137,15 @@ All animation gifs are stored here: [AtsushiSakai/PythonRoboticsGifs: Animation
123137> git clone https://github.com/AtsushiSakai/PythonRobotics.git
124138
125139
126- 2 . Install the required libraries. You can use environment.yml with conda command.
140+ 2 . Install the required libraries.
141+
142+ using conda :
127143
128144> conda env create -f environment.yml
129- > using pip :-
130- pip install -r requirements.txt
145+
146+ using pip :
147+
148+ > pip install -r requirements.txt
131149
132150
1331513 . Execute python script in each directory.
@@ -150,11 +168,11 @@ This is a sensor fusion localization with Particle Filter(PF).
150168
151169The blue line is true trajectory, the black line is dead reckoning trajectory,
152170
153- and the red line is estimated trajectory with PF.
171+ and the red line is an estimated trajectory with PF.
154172
155173It is assumed that the robot can measure a distance from landmarks (RFID).
156174
157- This measurements are used for PF localization.
175+ These measurements are used for PF localization.
158176
159177Ref:
160178
@@ -222,7 +240,7 @@ Simultaneous Localization and Mapping(SLAM) examples
222240
223241This is a 2D ICP matching example with singular value decomposition.
224242
225- It can calculate a rotation matrix and a translation vector between points to points.
243+ It can calculate a rotation matrix, and a translation vector between points and points.
226244
227245![ 3] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/SLAM/iterative_closest_point/animation.gif )
228246
@@ -267,15 +285,15 @@ This is a 2D navigation sample code with Dynamic Window Approach.
267285
268286### Dijkstra algorithm
269287
270- This is a 2D grid based shortest path planning with Dijkstra's algorithm.
288+ This is a 2D grid based the shortest path planning with Dijkstra's algorithm.
271289
272290![ PythonRobotics/figure_1.png at master · AtsushiSakai/PythonRobotics] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/Dijkstra/animation.gif )
273291
274292In the animation, cyan points are searched nodes.
275293
276294### A\* algorithm
277295
278- This is a 2D grid based shortest path planning with A star algorithm.
296+ This is a 2D grid based the shortest path planning with A star algorithm.
279297
280298![ PythonRobotics/figure_1.png at master · AtsushiSakai/PythonRobotics] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/AStar/animation.gif )
281299
@@ -369,7 +387,7 @@ This is a path planning simulation with LQR-RRT\*.
369387
370388A double integrator motion model is used for LQR local planner.
371389
372- ![ LQRRRT ] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/LQRRRTStar/animation.gif )
390+ ![ LQR_RRT ] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/LQRRRTStar/animation.gif )
373391
374392Ref:
375393
@@ -384,7 +402,7 @@ Motion planning with quintic polynomials.
384402
385403![ 2] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/QuinticPolynomialsPlanner/animation.gif )
386404
387- It can calculate 2D path, velocity, and acceleration profile based on quintic polynomials.
405+ It can calculate a 2D path, velocity, and acceleration profile based on quintic polynomials.
388406
389407Ref:
390408
@@ -420,7 +438,7 @@ This is optimal trajectory generation in a Frenet Frame.
420438
421439The cyan line is the target course and black crosses are obstacles.
422440
423- The red line is predicted path.
441+ The red line is the predicted path.
424442
425443Ref:
426444
507525
508526N joint arm to a point control simulation.
509527
510- This is a interactive simulation.
528+ This is an interactive simulation.
511529
512- You can set the goal position of the end effector with left-click on the ploting area.
530+ You can set the goal position of the end effector with left-click on the plotting area.
513531
514532![ 3] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/ArmNavigation/n_joint_arm_to_point_control/animation.gif )
515533
544562
545563## bipedal planner with inverted pendulum
546564
547- This is a bipedal planner for modifying footsteps with inverted pendulum.
565+ This is a bipedal planner for modifying footsteps for an inverted pendulum.
548566
549- You can set the footsteps and the planner will modify those automatically.
567+ You can set the footsteps, and the planner will modify those automatically.
550568
551569![ 3] ( https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Bipedal/bipedal_planner/animation.gif )
552570
@@ -566,8 +584,6 @@ This is a list of other user's comment and references:[users\_comments](https://
566584
567585Any contribution is welcome!!
568586
569- If your PR is merged multiple times, I will add your account to the author list.
570-
571587# Citing
572588
573589If you use this project's code for your academic work, we encourage you to cite [ our papers] ( https://arxiv.org/abs/1808.10703 )
@@ -584,26 +600,15 @@ If you or your company would like to support this project, please consider:
584600
585601- [ One-time donation via PayPal] ( https://www.paypal.me/myenigmapay/ )
586602
587- # Authors
588-
589- - [ Atsushi Sakai] ( https://github.com/AtsushiSakai/ )
590-
591- - [ Daniel Ingram] ( https://github.com/daniel-s-ingram )
592-
593- - [ Joe Dinius] ( https://github.com/jwdinius )
603+ If you would like to support us in some other way, please contact with creating an issue.
594604
595- - [ Karan Chawla ] ( https://github.com/karanchawla )
605+ # Sponsors
596606
597- - [ Antonin RAFFIN ] ( https://github. com/araffin )
607+ ## [ JetBrains ] ( https://www.jetbrains. com/ )
598608
599- - [ Alexis Paques ] ( https://github.com/AlexisTM )
609+ They are providing a free license of their IDEs for this OSS development.
600610
601- - [ Ryohei Sasaki] ( https://github.com/rsasaki0109 )
602-
603- - [ Göktuğ Karakaşlı] ( https://github.com/goktug97 )
604-
605- - [ Guillaume Jacquenot] ( https://github.com/Gjacquenot )
606-
607- - [ Erwin Lejeune] ( https://github.com/guilyx )
611+ # Authors
608612
613+ - [ Contributors to AtsushiSakai/PythonRobotics] ( https://github.com/AtsushiSakai/PythonRobotics/graphs/contributors )
609614
0 commit comments