Skip to content

Commit 5f8d733

Browse files
authored
Merge pull request #59 from fjanguita/harmonic_migration_docs
Documentation on Gazebo Harmonic migration
2 parents 1550967 + 8392ba4 commit 5f8d733

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

docs/_00_getting_started/source_install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ After that, make sure you have installed the following dependencies:
2020
2121
sudo apt install git python3-rosdep python3-pip python3-colcon-common-extensions -y
2222
23-
For simulation purposes, please :ref:`install Gazebo Fortress <aerial_platform_gazebo_installation_prerequisites>` to install the necessary dependencies.
23+
For simulation purposes, please :ref:`install Gazebo <aerial_platform_gazebo_installation_prerequisites>` in any of the supported versions to install the necessary dependencies.
2424

2525

2626

docs/_03_aerial_platforms/_gazebo_simulation/index.rst

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,41 @@ Installation
3333
Prerequisites
3434
=============
3535

36-
Gazebo in Fortress version is required. For installation instructions, follow the `Gazebo Fortress installation guide <https://gazebosim.org/docs/fortress/install_ubuntu>`__.
36+
Ignition Gazebo is required for simulation using this simulator. The default Gazebo version for working
37+
and simulating with Aerostack2 is Gazebo Fortress, which can be installed following the
38+
`Gazebo Fortress installation guide <https://gazebosim.org/docs/fortress/install_ubuntu>`__.
3739

40+
Using 'Gazebo Harmonic'
41+
-----------------------
3842

43+
Gazebo Harmonic is also supported by Aerostack2. For simulations to work with this version,
44+
make sure Gazebo Fortress is completely removed from your machine, since both versions are not
45+
compatible with Aerostack2 at the same time. To do so, first run:
46+
47+
.. code-block:: bash
48+
49+
sudo apt-get remove ignition-fortress
50+
sudo apt remove ignition*
51+
sudo apt autoremove
52+
53+
To ensure no ignition-fortress packages are cached with the Aerostack2 compilation, run the following
54+
`Aerostack2 CLI <https://aerostack2.github.io/_09_development/_cli/index.html#development-cli>`_ command to clean Aerostack2 if you have it compilled:
55+
56+
.. code-block:: bash
57+
58+
as2 clean -a
59+
source ~/.bashrc
60+
61+
After that, you can follow the `Gazebo Harmonic installation guide <https://gazebosim.org/docs/harmonic/install_ubuntu>`__
62+
to install the new Gazebo version.
63+
64+
.. warning:: An additional package must be installed for Aerostack2 to build:
65+
66+
.. code-block:: bash
67+
68+
sudo apt install ros-humble-ros-gzharmonic
69+
70+
.. note:: Gazebo Fortress can be re-installed to your machine after Aerostack2 has been compiled with Gazebo Harmonic if you need it, but compiling Aerostack2 with Fortress again will not be possible.
3971

4072
.. _aerial_platform_gazebo_installation_package:
4173

0 commit comments

Comments
 (0)