Skip to content

Commit 47fffba

Browse files
bperseghettiahcordemabelzhang
authored
Fix Garden documentation to remove ign for gz. (gazebosim#333)
Co-authored-by: Alejandro Hernández Cordero <[email protected]> Co-authored-by: Mabel Zhang <[email protected]>
1 parent b9e34ab commit 47fffba

File tree

12 files changed

+26
-62
lines changed

12 files changed

+26
-62
lines changed

garden/comparison.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ Feature | Gazebo-classic | Gazebo Sim
245245
-- | -- | --
246246
ODE engine | ✓ | [Issue](https://github.com/gazebosim/gz-physics/issues/63)
247247
Bullet engine | ✓ | ✓
248-
DART engine | ✓ | ✓ Plugin shipped with ign-physics
248+
DART engine | ✓ | ✓ Plugin shipped with gz-physics
249249
Simbody engine | ✓ | [Issue](https://github.com/gazebosim/gz-physics/issues/63)
250250
TPE engine | ✕ | ✓
251251
Custom engine plugins | ✕ | ✓
@@ -278,7 +278,7 @@ Render order | ✕ | ✓
278278
## ROS integration
279279

280280
ROS integration through the
281-
[ros_ign](https://github.com/gazebosim/ros_ign) packages.
281+
[ros_gz](https://github.com/gazebosim/ros_gz) packages.
282282

283283
Supported versions:
284284

garden/ign_docker_env.md

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

garden/index.yaml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,6 @@ pages:
4141
- name: troubleshooting
4242
title: Troubleshooting
4343
file: troubleshooting.md
44-
- name: ign_docker_env
45-
title: Dockerized Dev Env
46-
file: ign_docker_env.md
4744
- name: migration_from_ignition
4845
title: Migration from Ignition
4946
file: migration_from_ignition.md

garden/install_ubuntu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Garden binaries are provided for Ubuntu Focal and Jammy. The
44
Garden binaries are hosted in the packages.osrfoundation.org repository.
55
To install all of them, the metapackage `gz-garden` can be installed.
66

7-
**WARNING:** `gz-garden` cannot be installed alongside gazebo-classic (eg. `gazebo11`) since both use the `gz` command line tool. Trying to install `gz-garden` on a system that already has gazebo-classic installed from binaries will cause gazebo-classic and its dependencies to be uninstalled. Currently, the workarounds for this are to install from source or to use Docker for either [`gz-garden`](https://gazebosim.org/docs/garden/ign_docker_env) or [`gazebo-classic`](https://hub.docker.com/_/gazebo) so they are not installed side-by-side on the same system.
7+
**WARNING:** `gz-garden` cannot be installed alongside gazebo-classic (eg. `gazebo11`) since both use the `gz` command line tool. Trying to install `gz-garden` on a system that already has gazebo-classic installed from binaries will cause gazebo-classic and its dependencies to be uninstalled. Currently, the workarounds for this are to install from source or to use Docker [`gazebo-classic`](https://hub.docker.com/_/gazebo) so they are not installed side-by-side on the same system.
88

99
First install some necessary tools:
1010

garden/install_windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ WARNING: Current Windows support is experimental.
55
# Binary Installation on Windows 10
66

77
Most Gazebo packages are available in Windows 10 using the [conda-forge package manager](https://conda-forge.org/),
8-
and the Gazebo feedstock recipes can be found [here](https://github.com/conda-forge?q=libignition&type=&language=).
8+
and the Gazebo feedstock recipes can be found [here](https://github.com/search?q=org:conda-forge+libgz&type=code).
99

1010
Additionally, command line tools, the DART physics engine, and some tests are not currently supported in Windows.
1111

garden/ros2_integration.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For this tutorial to work correctly make sure you have the following installed:
1414

1515
* [ROS 2 Rolling](https://docs.ros.org/en/rolling/Installation.html) or [ROS 2 Humble](https://docs.ros.org/en/humble/Installation.html)
1616
* [Gazebo Garden](https://gazebosim.org/docs/garden)
17-
* [ros_gz_bridge](https://github.com/gazebosim/ros_ign/tree/ros2#from-source)
17+
* [ros_gz_bridge](https://github.com/gazebosim/ros_gz/tree/ros2#from-source)
1818

1919
## Bidirectional communication
2020

@@ -74,9 +74,7 @@ ros2 topic echo /keyboard/keypress
7474
This command listens to the messages sent over the `/keyboard/keypress` topic.
7575

7676
On the Gazebo window, press on the keyboard keys and you should
77-
find data on the listener terminal. This is what the terminals should look like:
78-
79-
![exchange_messages](tutorials/ros2_integration/ros_ign.png)
77+
find data on the listener terminal.
8078

8179
Now it's your turn! Try to send data from ROS to Gazebo. You can also try different data types and different directions of communication.
8280

garden/sensors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
In this tutorial we will learn how to add sensors to our robot and
77
to other models in our world. We will use three different sensors:
88
an IMU sensor, a Contact sensor and a Lidar sensor. We will also
9-
learn how to launch multiple tasks with just one file using `ign_launch`.
9+
learn how to launch multiple tasks with just one file using `gz launch`.
1010

1111
You can find the final world of this tutorial [here](https://github.com/gazebosim/docs/blob/master/garden/tutorials/sensors/sensor_tutorial.sdf)
1212

@@ -410,10 +410,10 @@ Instead of running two different tasks from two different terminals we can make
410410
The launch file is an XML file. We simply define what commands will run under the `<executable>` tag.
411411
The first command is `gz sim sensor_tutorial.sdf` which launches the world.
412412
And the second command is `./build/lidar_node` which runs the `lidar_node`.
413-
Save the file as `sensor_launch.ign`, and then run it using the following command:
413+
Save the file as `sensor_launch.gzlaunch`, and then run it using the following command:
414414

415415
```{.sh}
416-
gz launch sensor_launch.ign
416+
gz launch sensor_launch.gzlaunch
417417
```
418418

419419
Press the play button to start the simulation. Hurray! Our robot is now moving and avoiding the wall.

garden/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ https://github.com/osrf/ogre-2.3-release
159159
You should be able to use Ogre 1 without any issues however. You can check if
160160
that's working by running a world which uses Ogre 1 instead of Ogre 2, such as:
161161
162-
ign gazebo -v 3 lights.sdf
162+
gz sim -v 3 lights.sdf
163163
164-
If that loads, you can continue to use Ignition with Ogre 1, just use the
164+
If that loads, you can continue to use Gazebo with Ogre 1, just use the
165165
`--render-engine ogre` option.
166166
167167
## Windows

garden/tutorials/actors/actor_demo.sdf

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
<sdf version="1.8">
1+
<sdf version="1.9">
22
<world name="actors">
33
<plugin
4-
filename="libignition-gazebo-physics-system.so"
5-
name="ignition::gazebo::systems::Physics">
4+
filename="gz-sim-physics-system"
5+
name="gz::sim::systems::Physics">
66
</plugin>
77
<plugin
8-
filename="libignition-gazebo-sensors-system.so"
9-
name="ignition::gazebo::systems::Sensors">
8+
filename="libgz-sim-sensors-system.so"
9+
name="gz::sim::systems::Sensors">
1010
<render_engine>ogre</render_engine>
1111
</plugin>
1212
<plugin
13-
filename="libignition-gazebo-user-commands-system.so"
14-
name="ignition::gazebo::systems::UserCommands">
13+
filename="libgz-sim-user-commands-system.so"
14+
name="gz::sim::systems::UserCommands">
1515
</plugin>
1616
<plugin
17-
filename="libignition-gazebo-scene-broadcaster-system.so"
18-
name="ignition::gazebo::systems::SceneBroadcaster">
17+
filename="libgz-sim-scene-broadcaster-system.so"
18+
name="gz::sim::systems::SceneBroadcaster">
1919
</plugin>
2020

2121
<light type="directional" name="sun">
-96.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)