Welcome to gennav’s documentation!

A python package containing all the elements required to build robotics navigation algorithms. All components have been designed to be as modular as possible while following a unified API. This means all components work well with each other and its easy for the user add additional custom functionality.

Whats in the box

• Path planning algorithms
• Controllers
• Environment representations
• A bunch of useful utilities

Contents

• Quickstart
  • Requirements
  • Installation
  • Usage
• gennav.planners package
  • Subpackages
  • Submodules
  • gennav.planners.base module
  • Module contents
• gennav.envs package
  • Submodules
  • gennav.envs.base module
  • gennav.envs.binaryOccupancyGrid2D_env module
  • gennav.envs.common module
  • gennav.envs.polygon_env module
  • gennav.envs.scan_env module
  • Module contents
• gennav.controllers package
  • Subpackages
  • Submodules
  • gennav.controllers.base module
  • Module contents
• gennav.utils package
  • Subpackages
  • Submodules
  • gennav.utils.common module
  • gennav.utils.custom_exceptions module
  • gennav.utils.geometry module
  • gennav.utils.graph module
  • gennav.utils.path_processing module
  • gennav.utils.samplers module
  • gennav.utils.visualisation module
  • Module contents
• About