README.md

delphyne_gui

Description

delphyne_gui is a front-end visualizer for delphyne.

It also provides a road network visualizer for Maliput

API Documentation

Refer to Delphyne GUI's Online API Documentation.

Visualizer

See visualizer page.

Examples

delphyne_demos provides demos that rely on delphyne_gui for the visualization.

Installation

Supported platforms

Ubuntu Focal Fossa 20.04 LTS.

Source Installation on Ubuntu

Prerequisites

sudo apt install python3-rosdep python3-colcon-common-extensions

Build

1. Create colcon workspace if you don't have one yet.

   mkdir colcon_ws/src -p

2. Clone dependencies in the src folder

   cd colcon_ws/src
   git clone https://github.com/maliput/drake_vendor.git

   git clone https://github.com/maliput/delphyne.git
   

3. Clone this repository in the src folder

   cd colcon_ws/src
   git clone https://github.com/maliput/delphyne_gui.git

4. Install package dependencies via rosdep

   export ROS_DISTRO=foxy
   

   rosdep update
   rosdep install -i -y --rosdistro $ROS_DISTRO --from-paths src

5. Follow instructions to install drake via drake_vendor package.

6. Build the package

   colcon build --packages-up-to delphyne_gui

   Note: To build documentation a -BUILD_DOCS cmake flag is required:

   colcon build --packages-select delphyne_gui --cmake-args " -DBUILD_DOCS=On"

   More info at Building Documentation.

For further info refer to Source Installation on Ubuntu

Exported variables

Exported variables can be found at delphyne_gui/setup.sh.in:

• DELPHYNE_GUI_RESOURCE_ROOT: Contains the path of the installed delphyne_gui's resources.

For development

It is recommended to follow the guidelines for setting up a development workspace as described here.

Contributing

Please see CONTRIBUTING page.

License