Skip to content

Commit b613081

Browse files
WIP: Adding Distribution Table (#756)
* initial proto Signed-off-by: SteveMacenski <[email protected]> * adding cittaions page Signed-off-by: SteveMacenski <[email protected]> * Adding distro graphics Signed-off-by: SteveMacenski <[email protected]> * try this Signed-off-by: SteveMacenski <[email protected]> * try again Signed-off-by: SteveMacenski <[email protected]> * better use space Signed-off-by: SteveMacenski <[email protected]> * Balanace sizing Signed-off-by: SteveMacenski <[email protected]> * rever Signed-off-by: SteveMacenski <[email protected]> * try new font size Signed-off-by: SteveMacenski <[email protected]> * Trying something new Signed-off-by: SteveMacenski <[email protected]> * maybe done? Signed-off-by: SteveMacenski <[email protected]> * Reorg Signed-off-by: SteveMacenski <[email protected]> * liting Signed-off-by: SteveMacenski <[email protected]> * nuke foxy Signed-off-by: SteveMacenski <[email protected]> * nuke foxy Signed-off-by: SteveMacenski <[email protected]> --------- Signed-off-by: SteveMacenski <[email protected]>
1 parent a221d4f commit b613081

File tree

8 files changed

+169
-89
lines changed

8 files changed

+169
-89
lines changed

citations.rst

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
.. _citations:
2+
3+
Citations
4+
#########
5+
6+
If you use the navigation framework, an algorithm from this repository, or ideas from it
7+
please cite this work in your papers!
8+
9+
10+
S. Macenski, F. Martín, R. White, J. Clavero.
11+
`**The Marathon 2: A Navigation System** <https://arxiv.org/abs/2003.00368/>`_.
12+
**IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2020.**
13+
14+
IROS 2020 talk on Nav2 Marathon Experiments:
15+
16+
.. raw:: html
17+
18+
<h1 align="center">
19+
<div style="position: relative; padding-bottom: 0%; overflow: hidden; max-width: 100%; height: auto;">
20+
<iframe width="708" height="400" src="https://www.youtube.com/embed/QB7lOKp3ZDQ?autoplay=1&mute=1" frameborder="1" allowfullscreen></iframe>
21+
</div>
22+
</h1>
23+
24+
.. code-block:: bash
25+
26+
@InProceedings{macenski2020marathon2,
27+
author = {Macenski, Steven and Martin, Francisco and White, Ruffin and Ginés Clavero, Jonatan},
28+
title = {The Marathon 2: A Navigation System},
29+
booktitle = {2020 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
30+
year = {2020}
31+
}
32+
33+
If you use any of the algorithms in Nav2 or the analysis of the algorithms in your work, please cite this work in your papers!
34+
35+
S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson,
36+
`**From the desks of ROS maintainers: A survey of modern & capable mobile robotics algorithms in the robot operating system 2** <https://arxiv.org/pdf/2307.15236.pdf>`_,
37+
**Robotics and Autonomous Systems, 2023**
38+
39+
.. code-block:: bash
40+
41+
@article{macenski2023survey,
42+
title={From the desks of ROS maintainers: A survey of modern & capable mobile robotics algorithms in the robot operating system 2},
43+
author={S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson},
44+
year={2023},
45+
journal = {Robotics and Autonomous Systems}
46+
}
47+
48+
Smac Planner (Hybrid A*, State Lattice, 2D):
49+
50+
S. Macenski, M. Booker, J. Wallace,
51+
`**Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics** <https://arxiv.org/abs/2401.13078>`_,
52+
53+
.. code-block:: bash
54+
55+
@article{macenski2024smac,
56+
title={Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics},
57+
author={Steve Macenski and Matthew Booker and Josh Wallace},
58+
year={2024},
59+
journal = {Arxiv}
60+
}
61+
62+
Regulated Pure Pursuit Controller:
63+
64+
S. Macenski, S. Singh, F. Martin, J. Gines,
65+
`**Regulated Pure Pursuit for Robot Path Tracking** <https://arxiv.org/abs/2305.20026>`_,
66+
**Autonomous Robots, 2023.**
67+
68+
.. code-block:: bash
69+
70+
@article{macenski2023regulated,
71+
title={Regulated Pure Pursuit for Robot Path Tracking},
72+
author={Steve Macenski and Shrijit Singh and Francisco Martin and Jonatan Gines},
73+
year={2023},
74+
journal = {Autonomous Robots}
75+
}
76+
77+
VSLAM and formal comparisons for service robot needs:
78+
79+
A. Merzlyakov, S. Macenski.
80+
`**A Comparison of Modern General-Purpose Visual SLAM Approaches** <https://arxiv.org/abs/2107.07589>`_.
81+
**IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2021.**
82+
83+
.. code-block:: bash
84+
85+
@InProceedings{vslamComparison2021,
86+
author = {Merzlyakov, Alexey and Macenski, Steven},
87+
title = {A Comparison of Modern General-Purpose Visual SLAM Approaches},
88+
booktitle = {2021 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
89+
year = {2021}
90+
}

distro_graphics/Jazzy.png

2.1 MB
Loading

distro_graphics/galactic.png

1.39 MB
Loading

distro_graphics/humble.png

1.38 MB
Loading

distro_graphics/iron.png

2.03 MB
Loading

distro_graphics/kilted.png

1.06 MB
Loading

distro_graphics/rolling.png

1.39 MB
Loading

index.rst

Lines changed: 79 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,84 @@ It has tools to:
8686
We also provide a set of starting plugins to get you going.
8787
A list of all plugins can be found on :ref:`plugins` - but they include algorithms for the spanning cross section of common behaviors and robot platform types.
8888

89+
Distributions
90+
#############
91+
92+
Nav2 is available across multiple ROS 2 distributions with varying levels of support:
93+
94+
.. list-table::
95+
:widths: 50 50
96+
:header-rows: 0
97+
:class: distribution-table
98+
:align: center
99+
100+
* - .. raw:: html
101+
102+
<div style="text-align: center;">
103+
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Rolling Ridley</span></div>
104+
<div style="margin-bottom: 20px;"><span style="background-color: #007bff; color: white; padding: 12px 24px; border-radius: 25px; font-size: 15px; font-weight: bold;">Development</span></div>
105+
</div>
106+
107+
.. image:: distro_graphics/rolling.png
108+
:width: 300px
109+
:height: 300px
110+
:align: center
111+
- .. raw:: html
112+
113+
<div style="text-align: center;">
114+
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Kilted Kaiju</span></div>
115+
<div style="margin-bottom: 20px;"><span style="background-color: #28a745; color: white; padding: 12px 24px; border-radius: 25px; font-size: 15px; font-weight: bold;">Active Support</span></div>
116+
</div>
117+
118+
.. image:: distro_graphics/kilted.png
119+
:width: 300px
120+
:height: 300px
121+
:align: center
122+
* - .. raw:: html
123+
124+
<div style="text-align: center;">
125+
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Jazzy Jalapa</span></div>
126+
<div style="margin-bottom: 20px;"><span style="background-color: #28a745; color: white; padding: 12px 24px; border-radius: 25px; font-size: 15px; font-weight: bold;">Active Support</span></div>
127+
</div>
128+
129+
.. image:: distro_graphics/Jazzy.png
130+
:width: 300px
131+
:height: 300px
132+
:align: center
133+
- .. raw:: html
134+
135+
<div style="text-align: center;">
136+
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Iron Irwini</span></div>
137+
<div style="margin-bottom: 20px;"><span style="background-color: #dc3545; color: white; padding: 12px 24px; border-radius: 25px; font-size: 15px; font-weight: bold;">End of Life</span></div>
138+
</div>
139+
140+
.. image:: distro_graphics/iron.png
141+
:width: 300px
142+
:height: 300px
143+
:align: center
144+
* - .. raw:: html
145+
146+
<div style="text-align: center;">
147+
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Humble Hawksbill</span></div>
148+
<div style="margin-bottom: 20px;"><span style="background-color: #ffc107; color: black; padding: 12px 24px; border-radius: 25px; font-size: 15px; font-weight: bold;">Maintained</span></div>
149+
</div>
150+
151+
.. image:: distro_graphics/humble.png
152+
:width: 300px
153+
:height: 300px
154+
:align: center
155+
- .. raw:: html
156+
157+
<div style="text-align: center;">
158+
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Galactic Geochelone</span></div>
159+
<div style="margin-bottom: 20px;"><span style="background-color: #dc3545; color: white; padding: 12px 24px; border-radius: 25px; font-size: 15px; font-weight: bold;">End of Life</span></div>
160+
</div>
161+
162+
.. image:: distro_graphics/galactic.png
163+
:width: 300px
164+
:height: 300px
165+
:align: center
166+
89167
Related Projects
90168
################
91169

@@ -96,95 +174,6 @@ Check out related projects to Nav2:
96174
- `SLAM Toolbox <https://github.com/SteveMacenski/slam_toolbox>`_
97175
- `Fuse <https://github.com/locusrobotics/fuse>`_
98176

99-
Citations
100-
#########
101-
102-
If you use the navigation framework, an algorithm from this repository, or ideas from it
103-
please cite this work in your papers!
104-
105-
106-
S. Macenski, F. Martín, R. White, J. Clavero.
107-
`The Marathon 2: A Navigation System <https://arxiv.org/abs/2003.00368/>`_.
108-
IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2020.
109-
110-
IROS 2020 talk on Nav2 Marathon Experiments:
111-
112-
.. raw:: html
113-
114-
<h1 align="center">
115-
<div style="position: relative; padding-bottom: 0%; overflow: hidden; max-width: 100%; height: auto;">
116-
<iframe width="708" height="400" src="https://www.youtube.com/embed/QB7lOKp3ZDQ?autoplay=1&mute=1" frameborder="1" allowfullscreen></iframe>
117-
</div>
118-
</h1>
119-
120-
.. code-block:: bash
121-
122-
@InProceedings{macenski2020marathon2,
123-
author = {Macenski, Steven and Martin, Francisco and White, Ruffin and Ginés Clavero, Jonatan},
124-
title = {The Marathon 2: A Navigation System},
125-
booktitle = {2020 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
126-
year = {2020}
127-
}
128-
129-
If you use any of the algorithms in Nav2 or the analysis of the algorithms in your work, please cite this work in your papers!
130-
131-
S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson,
132-
`From the desks of ROS maintainers: A survey of modern & capable mobile robotics algorithms in the robot operating system 2 <https://arxiv.org/pdf/2307.15236.pdf>`_,
133-
Robotics and Autonomous Systems, 2023
134-
135-
.. code-block:: bash
136-
137-
@article{macenski2023survey,
138-
title={From the desks of ROS maintainers: A survey of modern & capable mobile robotics algorithms in the robot operating system 2},
139-
author={S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson},
140-
year={2023},
141-
journal = {Robotics and Autonomous Systems}
142-
}
143-
144-
Smac Planner (Hybrid A*, State Lattice, 2D):
145-
146-
S. Macenski, M. Booker, J. Wallace,
147-
`Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics <https://arxiv.org/abs/2401.13078>`_,
148-
149-
.. code-block:: bash
150-
151-
@article{macenski2024smac,
152-
title={Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics},
153-
author={Steve Macenski and Matthew Booker and Josh Wallace},
154-
year={2024},
155-
journal = {Arxiv}
156-
}
157-
158-
Regulated Pure Pursuit Controller:
159-
160-
S. Macenski, S. Singh, F. Martin, J. Gines,
161-
`Regulated Pure Pursuit for Robot Path Tracking <https://arxiv.org/abs/2305.20026>`_,
162-
Autonomous Robots, 2023.
163-
164-
.. code-block:: bash
165-
166-
@article{macenski2023regulated,
167-
title={Regulated Pure Pursuit for Robot Path Tracking},
168-
author={Steve Macenski and Shrijit Singh and Francisco Martin and Jonatan Gines},
169-
year={2023},
170-
journal = {Autonomous Robots}
171-
}
172-
173-
VSLAM and formal comparisons for service robot needs:
174-
175-
A. Merzlyakov, S. Macenski.
176-
`A Comparison of Modern General-Purpose Visual SLAM Approaches <https://arxiv.org/abs/2107.07589>`_.
177-
IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2021.
178-
179-
.. code-block:: bash
180-
181-
@InProceedings{vslamComparison2021,
182-
author = {Merzlyakov, Alexey and Macenski, Steven},
183-
title = {A Comparison of Modern General-Purpose Visual SLAM Approaches},
184-
booktitle = {2021 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
185-
year = {2021}
186-
}
187-
188177
.. toctree::
189178
:hidden:
190179

@@ -204,5 +193,6 @@ IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2021
204193
commander_api/index.rst
205194
API Docs <https://api.nav2.org>
206195
roadmap/roadmap.rst
196+
citations.rst
207197
about/index.rst
208198
maintainer_docs/index.rst

0 commit comments

Comments
 (0)