Installation

We provide installation instruction for macOS, Linux, and Windows.

Note

You can also try navground on binder without installing anything.

There are several ways to build/install navground, either from source or from binary distribution. Building navground from source let you customize and install everything you need, but pre-built may be more suitable (easier, faster) in some cases. The different ways to install/run navground, cover the following cases:

• to extend (and run) navground:

  • only from Python: install a pre-built wheel from PyPi

  • only from C++: install the cpp library released on github

  • from C++ and Python: install github release

  • or build from source

• to just run navground (e.g., to perform experiments in simulation): install a pre-built wheel from PyPi

• to run navground in ROS 2: build from source

• to use docker: build or pull one of the docker images

Except when building against a binary installation of ROS 2, we suggest installing navground in a Python virtual environment. In this case, start by creating and activating the virtual environment.

Linux & macOSWindows

python3 -m venv <path_to_the_venv>
. <path_to_the_venv>/bin/activate

• PyPi
• Github release
• Docker
• Building from source
• Step-by-step Instructions
• Setup a development environment
• Troubleshooting