Skip to content
90 changes: 90 additions & 0 deletions citations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
.. _citations:

Citations
#########

If you use the navigation framework, an algorithm from this repository, or ideas from it
please cite this work in your papers!


S. Macenski, F. Martín, R. White, J. Clavero.
`**The Marathon 2: A Navigation System** <https://arxiv.org/abs/2003.00368/>`_.
**IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2020.**

IROS 2020 talk on Nav2 Marathon Experiments:

.. raw:: html

<h1 align="center">
<div style="position: relative; padding-bottom: 0%; overflow: hidden; max-width: 100%; height: auto;">
<iframe width="708" height="400" src="https://www.youtube.com/embed/QB7lOKp3ZDQ?autoplay=1&mute=1" frameborder="1" allowfullscreen></iframe>
</div>
</h1>

.. code-block:: bash

@InProceedings{macenski2020marathon2,
author = {Macenski, Steven and Martin, Francisco and White, Ruffin and Ginés Clavero, Jonatan},
title = {The Marathon 2: A Navigation System},
booktitle = {2020 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
year = {2020}
}

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!

S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson,
`**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>`_,
**Robotics and Autonomous Systems, 2023**

.. code-block:: bash

@article{macenski2023survey,
title={From the desks of ROS maintainers: A survey of modern & capable mobile robotics algorithms in the robot operating system 2},
author={S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson},
year={2023},
journal = {Robotics and Autonomous Systems}
}

Smac Planner (Hybrid A*, State Lattice, 2D):

S. Macenski, M. Booker, J. Wallace,
`**Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics** <https://arxiv.org/abs/2401.13078>`_,

.. code-block:: bash

@article{macenski2024smac,
title={Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics},
author={Steve Macenski and Matthew Booker and Josh Wallace},
year={2024},
journal = {Arxiv}
}

Regulated Pure Pursuit Controller:

S. Macenski, S. Singh, F. Martin, J. Gines,
`**Regulated Pure Pursuit for Robot Path Tracking** <https://arxiv.org/abs/2305.20026>`_,
**Autonomous Robots, 2023.**

.. code-block:: bash

@article{macenski2023regulated,
title={Regulated Pure Pursuit for Robot Path Tracking},
author={Steve Macenski and Shrijit Singh and Francisco Martin and Jonatan Gines},
year={2023},
journal = {Autonomous Robots}
}

VSLAM and formal comparisons for service robot needs:

A. Merzlyakov, S. Macenski.
`**A Comparison of Modern General-Purpose Visual SLAM Approaches** <https://arxiv.org/abs/2107.07589>`_.
**IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2021.**

.. code-block:: bash

@InProceedings{vslamComparison2021,
author = {Merzlyakov, Alexey and Macenski, Steven},
title = {A Comparison of Modern General-Purpose Visual SLAM Approaches},
booktitle = {2021 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
year = {2021}
}
Binary file added distro_graphics/Jazzy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added distro_graphics/galactic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added distro_graphics/humble.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added distro_graphics/iron.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added distro_graphics/kilted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added distro_graphics/rolling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
168 changes: 79 additions & 89 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,84 @@ It has tools to:
We also provide a set of starting plugins to get you going.
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.

Distributions
#############

Nav2 is available across multiple ROS 2 distributions with varying levels of support:

.. list-table::
:widths: 50 50
:header-rows: 0
:class: distribution-table
:align: center

* - .. raw:: html

<div style="text-align: center;">
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Rolling Ridley</span></div>
<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>
</div>

.. image:: distro_graphics/rolling.png
:width: 300px
:height: 300px
:align: center
- .. raw:: html

<div style="text-align: center;">
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Kilted Kaiju</span></div>
<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>
</div>

.. image:: distro_graphics/kilted.png
:width: 300px
:height: 300px
:align: center
* - .. raw:: html

<div style="text-align: center;">
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Jazzy Jalapa</span></div>
<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>
</div>

.. image:: distro_graphics/Jazzy.png
:width: 300px
:height: 300px
:align: center
- .. raw:: html

<div style="text-align: center;">
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Iron Irwini</span></div>
<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>
</div>

.. image:: distro_graphics/iron.png
:width: 300px
:height: 300px
:align: center
* - .. raw:: html

<div style="text-align: center;">
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Humble Hawksbill</span></div>
<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>
</div>

.. image:: distro_graphics/humble.png
:width: 300px
:height: 300px
:align: center
- .. raw:: html

<div style="text-align: center;">
<div style="margin-bottom: 20px;"><span style="font-size: 20px; font-weight: bold;">Galactic Geochelone</span></div>
<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>
</div>

.. image:: distro_graphics/galactic.png
:width: 300px
:height: 300px
:align: center

Related Projects
################

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

Citations
#########

If you use the navigation framework, an algorithm from this repository, or ideas from it
please cite this work in your papers!


S. Macenski, F. Martín, R. White, J. Clavero.
`The Marathon 2: A Navigation System <https://arxiv.org/abs/2003.00368/>`_.
IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2020.

IROS 2020 talk on Nav2 Marathon Experiments:

.. raw:: html

<h1 align="center">
<div style="position: relative; padding-bottom: 0%; overflow: hidden; max-width: 100%; height: auto;">
<iframe width="708" height="400" src="https://www.youtube.com/embed/QB7lOKp3ZDQ?autoplay=1&mute=1" frameborder="1" allowfullscreen></iframe>
</div>
</h1>

.. code-block:: bash

@InProceedings{macenski2020marathon2,
author = {Macenski, Steven and Martin, Francisco and White, Ruffin and Ginés Clavero, Jonatan},
title = {The Marathon 2: A Navigation System},
booktitle = {2020 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
year = {2020}
}

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!

S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson,
`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>`_,
Robotics and Autonomous Systems, 2023

.. code-block:: bash

@article{macenski2023survey,
title={From the desks of ROS maintainers: A survey of modern & capable mobile robotics algorithms in the robot operating system 2},
author={S. Macenski, T. Moore, DV Lu, A. Merzlyakov, M. Ferguson},
year={2023},
journal = {Robotics and Autonomous Systems}
}

Smac Planner (Hybrid A*, State Lattice, 2D):

S. Macenski, M. Booker, J. Wallace,
`Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics <https://arxiv.org/abs/2401.13078>`_,

.. code-block:: bash

@article{macenski2024smac,
title={Open-Source, Cost-Aware Kinematically Feasible Planning for Mobile and Surface Robotics},
author={Steve Macenski and Matthew Booker and Josh Wallace},
year={2024},
journal = {Arxiv}
}

Regulated Pure Pursuit Controller:

S. Macenski, S. Singh, F. Martin, J. Gines,
`Regulated Pure Pursuit for Robot Path Tracking <https://arxiv.org/abs/2305.20026>`_,
Autonomous Robots, 2023.

.. code-block:: bash

@article{macenski2023regulated,
title={Regulated Pure Pursuit for Robot Path Tracking},
author={Steve Macenski and Shrijit Singh and Francisco Martin and Jonatan Gines},
year={2023},
journal = {Autonomous Robots}
}

VSLAM and formal comparisons for service robot needs:

A. Merzlyakov, S. Macenski.
`A Comparison of Modern General-Purpose Visual SLAM Approaches <https://arxiv.org/abs/2107.07589>`_.
IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2021.

.. code-block:: bash

@InProceedings{vslamComparison2021,
author = {Merzlyakov, Alexey and Macenski, Steven},
title = {A Comparison of Modern General-Purpose Visual SLAM Approaches},
booktitle = {2021 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
year = {2021}
}

.. toctree::
:hidden:

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