Skip to main content

A playground to experiment with navigation algorithms.

Project description

navground

Navground, short for Navigation Playground, is a playground to experiment with navigation algorithms. It is a modular library, primary implemented in C++.

This package provides Python bindings to the core and simulation sub-libraries. With this package, you can use navground but also extend it.

Core library

A library of two-dimensional navigation algorithms which provides a common API to interact with dynamic obstacle avoidance behaviors for multi-agent systems. Some behaviors are already implemented, more will be. Behaviors take the current state of environment and agent together with a target, and output a control command.

Features

  • navigation behaviors and modulations
  • environment states
  • targets
  • kinematics
  • 2D and 2.5D controllers with an event-based interface
  • collisions computation
  • YAML serialization

Users can add their components (behaviors and kinematics) which are then auto-discovered by the rest of the system.

The core library is designed to be integrated in real-time run-times of real or simulated robots or of other kind of agents.

Simulation

The simulation complements the navigation behaviors of the core library with:

  • tasks that generate targets for behaviors, and
  • state estimation components that feed a potentially noisy and partial representation of the environment state to the behaviors.

It also provides all the infrastructure to run offline experiments.

Features

  • very fast kinematic simulation
  • extensible tasks and state estimations
  • generating world with agents and static obstacles from scenarios
  • running experiments/benchmarks and recording data in HFD5 files
  • using YAML to specify experiments

Documentation

For more information, we refer to the project documentation that contains also detailed installation instructions.

Try the tutorials on binder

Binder

License and copyright

This software is free for reuse according to the attached MIT license.

Acknowledgement and disclaimer

The work was supported in part by REXASI-PRO H-EU project, call HORIZON-CL4-2021-HUMAN-01-01, Grant agreement no. 101070028.

The work has been partially funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Commission. Neither the European Union nor the European Commission can be held responsible for them.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

navground-0.1.0-cp312-cp312-win_amd64.whl (7.2 MB view details)

Uploaded CPython 3.12 Windows x86-64

navground-0.1.0-cp312-cp312-manylinux_2_34_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.34+ x86-64

navground-0.1.0-cp312-cp312-manylinux_2_31_x86_64.whl (6.1 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.31+ x86-64

navground-0.1.0-cp312-cp312-macosx_14_0_universal2.whl (4.2 MB view details)

Uploaded CPython 3.12 macOS 14.0+ universal2 (ARM64, x86-64)

navground-0.1.0-cp311-cp311-win_amd64.whl (7.1 MB view details)

Uploaded CPython 3.11 Windows x86-64

navground-0.1.0-cp311-cp311-manylinux_2_34_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.34+ x86-64

navground-0.1.0-cp311-cp311-manylinux_2_31_x86_64.whl (6.1 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.31+ x86-64

navground-0.1.0-cp311-cp311-macosx_14_0_universal2.whl (4.2 MB view details)

Uploaded CPython 3.11 macOS 14.0+ universal2 (ARM64, x86-64)

navground-0.1.0-cp310-cp310-win_amd64.whl (7.1 MB view details)

Uploaded CPython 3.10 Windows x86-64

navground-0.1.0-cp310-cp310-manylinux_2_34_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.34+ x86-64

navground-0.1.0-cp310-cp310-manylinux_2_31_x86_64.whl (6.1 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.31+ x86-64

navground-0.1.0-cp310-cp310-macosx_14_0_universal2.whl (4.2 MB view details)

Uploaded CPython 3.10 macOS 14.0+ universal2 (ARM64, x86-64)

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page