Skip to content

Commit

Permalink
[15] Acropolis ign (gazebosim#271)
Browse files Browse the repository at this point in the history
* Rename Ignition to Gazebo in ci.md

Signed-off-by: Nate Koenig <[email protected]>

* Rename Ignition to Gazebo in contributing.md

Signed-off-by: Nate Koenig <[email protected]>

* Rename Ignition to Gazebo in release_features.md

Signed-off-by: Nate Koenig <[email protected]>

* Rename ignition to gazebo in release.md

Signed-off-by: Nate Koenig <[email protected]>

* Rename ignition in readme, and yaml files

Signed-off-by: Nate Koenig <[email protected]>

* Update releases.md

Signed-off-by: Nate Koenig <[email protected]>

* Rename ign in acropolis

Signed-off-by: Nate Koenig <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>
  • Loading branch information
nkoenig and Nate Koenig authored Jun 30, 2022
1 parent 2b61d8d commit bf21f1f
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 53 deletions.
18 changes: 9 additions & 9 deletions acropolis/comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Please refer to the latest supported version.**
# Feature comparison

A list of features present in [Gazebo-classic](https://github.com/osrf/gazebo/) and
the status of their migration to [Ignition](https://gazebosim.org/).
the status of their migration to [Gazebo](https://gazebosim.org/).

## Sensors

Expand Down Expand Up @@ -139,21 +139,21 @@ Position, resize and configure widgets | ✕ | ✓

## Physics

In Ignition Physics, physics engines are integrated as plugins, so any engine
In Gazebo Physics, physics engines are integrated as plugins, so any engine
can be integrated without changing the core source code, as it was the case
in Gazebo.

Feature | Gazebo-classic | Gazebo Sim
-- | -- | --
ODE engine | ✓ |
Bullet engine | ✓ |
DART engine | ✓ | ✓ Plugin shipped with ign-physics
DART engine | ✓ | ✓ Plugin shipped with gz-physics
Simbody engine | ✓ |
Custom engine plugins | ✕ | ✓

## Rendering

In Ignition Rendering, render engines are integrated as plugins, so any engine
In Gazebo Rendering, render engines are integrated as plugins, so any engine
can be integrated without changing the core source code.

Feature | Gazebo-classic | Gazebo Sim
Expand All @@ -167,11 +167,11 @@ Fog | ✓ |

## ROS integration

ROS integration with Ignition will be done primarily via a
ROS integration with Gazebo will be done primarily via a
transport bridge instead of plugins, contained in the
[ros_ign](https://github.com/osrf/ros1_ign) package.
[ros_gz](https://github.com/osrf/ros1_ign) package.

* **ROS 1**: See full message list at [ros_ign](https://github.com/osrf/ros_ign)
* **ROS 1**: See full message list at [ros_gz](https://github.com/osrf/ros_ign)
* **ROS 2**: Available from Blueprint

## Others
Expand All @@ -195,10 +195,10 @@ World plugins | ✓ | ✓ Now called System plugin
Model plugins | ✓ | ✓ Now called System plugin
Sensor plugins | ✓ |
Visual plugins | ✓ |
GUI plugins | ✓ | ✓ Ignition GUI plugins
GUI plugins | ✓ | ✓ Gazebo GUI plugins
System plugins | ✓ |
Distribute simulation across processes | ✕ | (coming up)
Incrementally load levels | ✕ | ✓
Online model database | [gazebo_models repository](https://github.com/osrf/gazebo_models/) | [Ignition Fuel](https://app.gazebosim.org/fuel/models)
Online model database | [gazebo_models repository](https://github.com/osrf/gazebo_models/) | [Gazebo Fuel](https://app.gazebosim.org/fuel/models)
SDF frame semantics | |
Saved simulation states | ✓ |
4 changes: 2 additions & 2 deletions acropolis/index.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# This file is an index of the pages to display on the documentation website
# (https://ignitionrobotics.org/docs). The order of the pages in this file
# (https://gazebosim.org/docs). The order of the pages in this file
# is reflected on the website's left sidebar.
#
# Components of the index:
Expand All @@ -26,4 +26,4 @@ pages:
- name: comparison
title: Feature Comparison
file: comparison.md
description: A list of features present in Gazebo-classic and the status of their migration to Ignition.
description: A list of features present in Gazebo-classic and the status of their migration to Gazebo.
62 changes: 31 additions & 31 deletions acropolis/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,46 +10,46 @@ Acropolis supports the following platforms:
* MacOS Mojave

Windows support is still experimental although most of the packages should work
as expected. There are no binaries for Windows at this moment. The `ign-gazebo`
as expected. There are no binaries for Windows at this moment. The `gz-sim`
package is still not available for Windows, the installation should be done from
source code.

## Acropolis Libraries

The Acropolis collection is composed by many different Ignition libraries. The
The Acropolis collection is composed by many different Gazebo libraries. The
collection assures that all libraries all compatible and can be used together.

| Library name | Version |
| ------------------ |:-------------:|
| ign-cmake | 2.x |
| ign-common | 3.x |
| ign-fuel-tools | 3.x |
| ign-gazebo | 1.x |
| ign-gui | 1.x |
| ign-launch | 0.x |
| ign-math | 6.x |
| ign-msgs | 3.x |
| ign-physics | 1.x |
| ign-plugin | 1.x |
| ign-rendering | 1.x |
| ign-sensors | 1.x |
| ign-tools | 0.x |
| ign-transport | 6.x |
| gz-cmake | 2.x |
| gz-common | 3.x |
| gz-fuel-tools | 3.x |
| gz-sim | 1.x |
| gz-gui | 1.x |
| gz-launch | 0.x |
| gz-math | 6.x |
| gz-msgs | 3.x |
| gz-physics | 1.x |
| gz-plugin | 1.x |
| gz-rendering | 1.x |
| gz-sensors | 1.x |
| gz-tools | 0.x |
| gz-transport | 6.x |
| sdformat | 8.x |

# Option 1: Installation on Ubuntu Bionic

All of the Acropolis binaries are hosted in the osrfoundation repository. To install
all of them, the metapackage `ignition-acropolis` can be installed:
all of them, the metapackage `gazebo-acropolis` can be installed:

```bash
sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
sudo apt-get update
sudo apt-get install ignition-acropolis
sudo apt-get install gazebo-acropolis
```

All libraries should be ready to use and the `ign-gazebo` app ready to be executed.
All libraries should be ready to use and the `gz-sim` app ready to be executed.

# Option 2: Install on MacOS Mojave (10.14)

Expand All @@ -60,14 +60,14 @@ The homebrew tool can easily be installed using:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
```

After installing the homebrew package manager, ignition acropolis can be installed running:
After installing the homebrew package manager, Gazebo Acropolis can be installed running:

```bash
brew tap osrf/simulation
brew install ignition-acropolis
brew install gazebo-acropolis
```

All libraries should be ready to use and the `ign-gazebo` app ready to be executed.
All libraries should be ready to use and the `gz-sim` app ready to be executed.

# Option 3: Source Installation (any platform)

Expand All @@ -86,7 +86,7 @@ in all platforms:
pip install vcstool
```

To compile all the different libraries and ign-gazebo in the right order
To compile all the different libraries and gz-sim in the right order
it is recommended to use [colcon](https://colcon.readthedocs.io/en/released/).
The colcon tool is available in all platforms using pip:

Expand Down Expand Up @@ -121,14 +121,14 @@ mkdir -p ~/workspace/src
cd ~/workspace/src
```

All the sources of ignition-acropolis are declared in a yaml file. Download
All the sources of gazebo-acropolis are declared in a yaml file. Download
it to the workspace.

```bash
wget https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-acropolis.yaml
wget https://raw.githubusercontent.com/gazebo-tooling/gazebodistro/master/collection-acropolis.yaml
```

Use `vcstool` to automatically retrieve all the Ignition libraries sources from
Use `vcstool` to automatically retrieve all the Gazebo libraries sources from
their repositories:

```bash
Expand Down Expand Up @@ -156,9 +156,9 @@ install all dependencies in Ubuntu Bionic:
sudo apt-get install cmake freeglut3-dev libavcodec-dev libavdevice-dev libavformat-dev libavutil-dev libdart6-collision-ode-dev libdart6-dev libdart6-utils-urdf-dev libfreeimage-dev libgflags-dev libglew-dev libgts-dev libogre-1.9-dev libogre-2.1-dev libprotobuf-dev libprotobuf-dev libprotoc-dev libqt5core5a libswscale-dev libtinyxml2-dev libtinyxml-dev pkg-config protobuf-compiler qml-module-qt-labs-folderlistmodel qml-module-qt-labs-settings qml-module-qtquick2 qml-module-qtquick-controls qml-module-qtquick-controls2 qml-module-qtquick-dialogs qml-module-qtquick-layouts qtbase5-dev qtdeclarative5-dev qtquickcontrols2-5-dev ruby ruby-ronn uuid-dev libgtest-dev curl libcurl4-gnutls-dev libcurl4-openssl-dev libsqlite3-dev
```

## Building the Ignition Libraries
## Building the Gazebo Libraries

The Ignition Libraries require the following compilers on each platform:
The Gazebo Libraries require the following compilers on each platform:

* Ubuntu Bionic: gcc 8
* MacOS Mojave: Xcode 10
Expand Down Expand Up @@ -197,7 +197,7 @@ cd ~/workspace/
colcon list -g
```

`colcon` should list the Ignition libraries with their
`colcon` should list the Gazebo libraries with their
interdependencies. If that is the case, then you are ready
to build the whole set of libraries:

Expand All @@ -209,8 +209,8 @@ If there are no errors, all the binaries should be ready to use.

## Using the workspace

The workspace binaries are ready but every time that `ign-gazebo` needs to be
executed or third party code is going to be developed using the Ignition
The workspace binaries are ready but every time that `gz-sim` needs to be
executed or third party code is going to be developed using the Gazebo
libraries, one command is needed:

```bash
Expand Down
22 changes: 11 additions & 11 deletions acropolis/ros_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ Please refer to the latest supported version.**

# ROS Integration

Most of the Ignition libraries use [Ignition Transport](https://github.com/gazebosim/gz-transport)
Most of the Gazebo libraries use [Gazebo Transport](https://github.com/gazebosim/gz-transport)
to exchange data between different software components. This tutorial details
how to interface with [ROS](http://www.ros.org/), enabling the ability to use
tools such as [Rviz](http://wiki.ros.org/rviz) for robot or sensor
visualization.

# ros1_ign_bridge to the rescue
# ros1_gz_bridge to the rescue

ros1_ign_bridge provides a network bridge which enables the exchange of messages
between ROS 1 and Ignition Transport. Its support is limited to only certain
ros1_gz_bridge provides a network bridge which enables the exchange of messages
between ROS 1 and Gazebo Transport. Its support is limited to only certain
message types. Please, read this [README](https://github.com/osrf/ros1_ign_bridge)
to verify if your message type is supported by the bridge.

# How to install ros1_ign_bridge
# How to install ros1_gz_bridge

## Binary install

Expand All @@ -37,7 +37,7 @@ sudo apt install ros-melodic-desktop ros-melodic-rqt-image-view libignition-comm

# Run the bridge and exchange images

In this example, we're going to generate Ignition Transport images using Gazebo, that will be converted into ROS 1 images, and visualized with rqt_viewer.
In this example, we're going to generate Gazebo Transport images using Gazebo, that will be converted into ROS 1 images, and visualized with rqt_viewer.

First we start a ROS 1 `roscore`:

Expand All @@ -51,15 +51,15 @@ Then we start Gazebo.

```bash
# Shell B:
ign-gazebo -r -f camera_sensor.sdf
gz sim -r -f camera_sensor.sdf
```

Gazebo should be running and publishing images over the `/camera` topic.
Let's verify it:

```bash
# Shell C:
ign topic -l | grep "^/camera"
gz topic -l | grep "^/camera"
/camera
```

Expand All @@ -68,7 +68,7 @@ Then we start the parameter bridge with the previous topic.
```bash
# Shell D:
. ~/bridge_ws/install/setup.bash
rosrun ros1_ign_bridge parameter_bridge /camera@sensor_msgs/[email protected]
rosrun ros1_gz_bridge parameter_bridge /camera@sensor_msgs/[email protected]
```

Now we start the ROS 1 GUI:
Expand All @@ -80,10 +80,10 @@ rqt_image_view /camera
```

You should see the current images in `rqt_image_view` which are coming from
Gazebo (published as Ignition Msgs over Ignition Transport).
Gazebo (published as Gazebo Msgs over Gazebo Transport).

The screenshot shows all the shell windows and their expected content
(it was taken using ROS Melodic):


![Ignition Transport images and ROS 1 rqt](images/bridge_image_exchange_ign-gazebo.png)
![Gazebo Transport images and ROS 1 rqt](images/bridge_image_exchange_gz-sim.png)

0 comments on commit bf21f1f

Please sign in to comment.