Skip to content

Commit 729235d

Browse files
committed
[skip ci] publish latest
Signed-off-by: fmrico <fmrico@gmail.com>
1 parent a2937ed commit 729235d

16 files changed

Lines changed: 305 additions & 276 deletions

File tree

_images/easynav_cycle.png

-231 KB
Binary file not shown.

_images/easynav_cycle.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

_images/easynav_design.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

_sources/build_instructions/index.rst.txt

Lines changed: 0 additions & 33 deletions
This file was deleted.

_sources/index.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,5 @@ If you use this software in your work, please consider citing our next paper.
4343

4444
getting_started/index.rst
4545
design/index.rst
46+
software/index.rst
4647
about/index.rst

_sources/software/index.rst.txt

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
.. _software:
2+
3+
EasyNav Software
4+
################
5+
6+
The EasyNav software is developed under the `EasyNavigation GitHub organization <https://github.com/EasyNavigation>`_, and it follows a **highly modular structure**. This modularity is reflected in the separation of functionality across multiple repositories, each dedicated to a specific role or typology:
7+
8+
Core
9+
----
10+
11+
- `EasyNavigation <https://github.com/EasyNavigation/EasyNavigation>`_
12+
This is the main repository that contains the core infrastructure of EasyNav, including the lifecycle management, execution engine, and common interfaces.
13+
14+
Plugins
15+
-------
16+
17+
- `easynav_plugins <https://github.com/EasyNavigation/easynav_plugins>`_
18+
A collection of lightweight plugins that do not depend on external libraries. It includes generic implementations for controllers, planners, localizers, etc.
19+
20+
Stacks
21+
------
22+
23+
Stacks are collections of plugins that typically share a common representation of the environment and often rely on specific third-party libraries.
24+
25+
- `easynav_simple_stack <https://github.com/EasyNavigation/easynav_simple_stack>`_
26+
Plugins based on 2D gridmaps representing free (0) and occupied (1) cells. Designed to serve as an introduction to EasyNav and to validate the core system.
27+
28+
- `easynav_gridmap_stack <https://github.com/EasyNavigation/easynav_gridmap_stack>`_
29+
Plugins that use the `GridMap <https://github.com/ANYbotics/grid_map>`_ library to support elevation maps and metric layers.
30+
31+
- `easynav_octomap_stack <https://github.com/EasyNavigation/easynav_octomap_stack>`_
32+
Plugins that rely on the `OctoMap <https://github.com/OctoMap>`_ library for 3D occupancy mapping.
33+
34+
- `easynav_pointcloud_stack <https://github.com/EasyNavigation/easynav_pointcloud_stack>`_
35+
Plugins that use the `PCL (Point Cloud Library) <https://pointclouds.org/>`_ to process and interpret point cloud data.
36+
37+
Test Cases
38+
----------
39+
40+
These repositories provide maps and configuration files tailored to common application scenarios:
41+
42+
- `easynav_indoor_testcase <https://github.com/EasyNavigation/easynav_indoor_testcase>`_
43+
Contains test environments for indoor navigation with flat 2D maps.
44+
45+
- `easynav_outdoor_testcase <https://github.com/EasyNavigation/easynav_outdoor_testcase>`_
46+
Focused on outdoor scenarios involving uneven terrain and unstructured environments.
47+
48+
Playgrounds
49+
-----------
50+
51+
Playgrounds define simulation setups for specific robot platforms in various environments.
52+
53+
- `easynav_playground_kobuki <https://github.com/EasyNavigation/easynav_playground_kobuki>`_
54+
Simulation models and example scenarios for the Turtlebot2 (Kobuki) robot.
55+
56+
- `easynav_playground_summit <https://github.com/EasyNavigation/easynav_playground_summit>`_
57+
Simulation of the SUMMIT XL robot from Robotnik, designed for both indoor and outdoor navigation tasks.

about/index.html

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<script src="../_static/js/theme.js"></script>
2121
<link rel="index" title="Index" href="../genindex.html" />
2222
<link rel="search" title="Search" href="../search.html" />
23-
<link rel="prev" title="Core Design and Architecture" href="../design/index.html" />
23+
<link rel="prev" title="EasyNav Software" href="../software/index.html" />
2424

2525
<link rel="stylesheet" href="../_static/tcs_theme.css" type="text/css" />
2626

@@ -52,21 +52,18 @@
5252
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
5353
<ul class="current">
5454
<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
55-
<li class="toctree-l1"><a class="reference internal" href="../build_instructions/index.html">Build and Install</a><ul>
56-
<li class="toctree-l2"><a class="reference internal" href="../build_instructions/index.html#install">Install</a></li>
57-
<li class="toctree-l2"><a class="reference internal" href="../build_instructions/index.html#build">Build</a><ul>
58-
<li class="toctree-l3"><a class="reference internal" href="../build_instructions/index.html#install-ros">Install ROS</a></li>
59-
<li class="toctree-l3"><a class="reference internal" href="../build_instructions/index.html#build-easynav">Build EasyNav</a></li>
60-
</ul>
61-
</li>
55+
<li class="toctree-l1"><a class="reference internal" href="../design/index.html">Core Design and Architecture</a><ul>
56+
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#navstate-the-shared-blackboard">NavState: The Shared Blackboard</a></li>
57+
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#real-time-execution-model">Real-Time Execution Model</a></li>
58+
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#plugin-configuration">Plugin Configuration</a></li>
6259
</ul>
6360
</li>
64-
<li class="toctree-l1"><a class="reference internal" href="../design/index.html">Core Design and Architecture</a><ul>
65-
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#main-concepts">Main Concepts</a></li>
66-
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#navstate">NavState</a></li>
67-
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#execution-model">Execution Model</a></li>
68-
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#plugin-types">Plugin Types</a></li>
69-
<li class="toctree-l2"><a class="reference internal" href="../design/index.html#summary">Summary</a></li>
61+
<li class="toctree-l1"><a class="reference internal" href="../software/index.html">EasyNav Software</a><ul>
62+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#core">Core</a></li>
63+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#plugins">Plugins</a></li>
64+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#stacks">Stacks</a></li>
65+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#test-cases">Test Cases</a></li>
66+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#playgrounds">Playgrounds</a></li>
7067
</ul>
7168
</li>
7269
<li class="toctree-l1 current"><a class="current reference internal" href="#">About and Contact</a><ul>

build_instructions/index.html

Lines changed: 0 additions & 169 deletions
This file was deleted.

design/index.html

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<script src="../_static/js/theme.js"></script>
2121
<link rel="index" title="Index" href="../genindex.html" />
2222
<link rel="search" title="Search" href="../search.html" />
23-
<link rel="next" title="About and Contact" href="../about/index.html" />
23+
<link rel="next" title="EasyNav Software" href="../software/index.html" />
2424
<link rel="prev" title="Getting Started" href="../getting_started/index.html" />
2525

2626
<link rel="stylesheet" href="../_static/tcs_theme.css" type="text/css" />
@@ -53,21 +53,20 @@
5353
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
5454
<ul class="current">
5555
<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
56-
<li class="toctree-l1"><a class="reference internal" href="../build_instructions/index.html">Build and Install</a><ul>
57-
<li class="toctree-l2"><a class="reference internal" href="../build_instructions/index.html#install">Install</a></li>
58-
<li class="toctree-l2"><a class="reference internal" href="../build_instructions/index.html#build">Build</a><ul>
59-
<li class="toctree-l3"><a class="reference internal" href="../build_instructions/index.html#install-ros">Install ROS</a></li>
60-
<li class="toctree-l3"><a class="reference internal" href="../build_instructions/index.html#build-easynav">Build EasyNav</a></li>
61-
</ul>
62-
</li>
63-
</ul>
64-
</li>
6556
<li class="toctree-l1 current"><a class="current reference internal" href="#">Core Design and Architecture</a><ul>
6657
<li class="toctree-l2"><a class="reference internal" href="#navstate-the-shared-blackboard">NavState: The Shared Blackboard</a></li>
6758
<li class="toctree-l2"><a class="reference internal" href="#real-time-execution-model">Real-Time Execution Model</a></li>
6859
<li class="toctree-l2"><a class="reference internal" href="#plugin-configuration">Plugin Configuration</a></li>
6960
</ul>
7061
</li>
62+
<li class="toctree-l1"><a class="reference internal" href="../software/index.html">EasyNav Software</a><ul>
63+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#core">Core</a></li>
64+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#plugins">Plugins</a></li>
65+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#stacks">Stacks</a></li>
66+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#test-cases">Test Cases</a></li>
67+
<li class="toctree-l2"><a class="reference internal" href="../software/index.html#playgrounds">Playgrounds</a></li>
68+
</ul>
69+
</li>
7170
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">About and Contact</a><ul>
7271
<li class="toctree-l2"><a class="reference internal" href="../about/index.html#id1">About</a></li>
7372
<li class="toctree-l2"><a class="reference internal" href="../about/index.html#contact">Contact</a></li>

0 commit comments

Comments
 (0)