maliput_malidrive repository

Repository Summary

Checkout URI https://github.com/maliput/maliput_malidrive.git
VCS Type git
VCS Version main
Last Updated 2022-11-29
Dev Status DEVELOPED
CI status No Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Packages

Name Version
maliput_malidrive 0.1.3

README

gcc

maliput_malidrive

Description

maliput_malidrive package is a Maliput backend implementation. Its underlying format specification is based on OpenDRIVE format. Allowing the users to load a road network out of a XODR file description.

Please go to XODR Parser capabilities for further information about OpenDRIVE's parser.

Note: For full information about Maliput please visit Maliput Documentation.

Resources

maliput_malidrive provides several map resources at maliput_malidrive/resources. These resources are: - XODR files for describing different road networks using OpenDRIVE format specification. - YAML files for describing maliput's road network information of type: Range Value Rules, Discrete Value Rules, Traffic Lights, Phase Rings, Intersections, etc.

Resources are installed natively, so the users are able to use them for their own interest. In order to get the installation path check the environment variable: MALIPUT_MALIDRIVE_RESOURCE_ROOT.

API Documentation

Refer to Maliput Malidrive's Online API Documentation.

Examples

Getting Started page is a good place for starting to see Maliput's capabilities and how to use a Maliput backend for getting a road network.

Installation

Supported platforms

Ubuntu Focal Fossa 20.04 LTS.

Binary Installation on Ubuntu

See Installation Docs.

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

  1. Clone this repository in the src folder
    cd colcon_ws/src
    git clone https://github.com/maliput/maliput_malidrive.git

  1. Install package dependencies via rosdep
    export ROS_DISTRO=foxy

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

  1. Build the package
    colcon build --packages-up-to maliput_malidrive

**Note**: To build documentation a `-BUILD_DOCS` cmake flag is required:
    colcon build --packages-select maliput_malidrive --cmake-args " -DBUILD_DOCS=On"

More info at [Building Documentation](https://maliput.readthedocs.io/en/latest/developer_guidelines.html#building-the-documentation).

For further info refer to Source Installation on Ubuntu

For development

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

Contributing

Please see CONTRIBUTING page.

License

License

CONTRIBUTING

No CONTRIBUTING.md found.