Installation and Setup

Installation and Setup

Ignition RViz will be available as binaries in the near future. Till then, you can try it out by building it from source.

Requirements

• ROS 2 Foxy
• Ignition Dome (under development)
  • Ignition Common 3
  • Ignition GUI 4
  • Ignition Math 6
  • Ignition Rendering 4
• Qt5

Setup the repository

• Create a colcon workspace

mkdir -p ~/colcon_ws/src
cd ~/colcon_ws/src

• Clone the repository

git clone https://github.com/ignitionrobotics/ign-rviz.git

• Build ign-rviz

# Go to the root of your colcon workspace
cd ../

# Source ROS2
source /opt/ros/foxy/setup.bash  # If using bash
source /opt/ros/foxy/setup.zsh   # If using zsh

# Build ign-rviz
colcon build

Launch ign-rviz

Ignition Rviz can be launched using the following command

# Source the workspace
source install/setup.zsh

# Launch ign-rviz
ros2 launch ign_rviz rviz.launch.py

Instruction to generate documentation

Project documentation can be generated with the help of doxygen using the following commands.

cd ~/colcon_ws/src/ign-rviz/docs/

# Generate documentation
doxygen rviz.doxyfile

# View documentation
firefox ./html/index.html