Maliput Py

Description

The maliput_py package provides a python interface covering the Maliput's API. For the binding creation, pybind11 tool has been used.

Please visit Maliput Python Interface for further information.

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

API Documentation

Refer to Maliput Py's Online API Documentation.

Examples

Getting Started page is a good place for starting to see the Maliput Py's capabilities.

• maliput_integration: Concentrates applications created for maliput. See maliput_integration's tutorials. In particular, there is one application that uses the python interface. See here

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

2. Clone this repository in the src folder

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

3. Install package dependencies via rosdep

   export ROS_DISTRO=foxy
   

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

4. Build the package

   colcon build --packages-up-to maliput_py

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

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

   More info at Building 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