Skip to main content

Python Package for Robot Navigation Algorithms

Project description

GenNav

License: MIT Build Status Language grade: Python Total alerts Documentation Status

Status: Under Development

A Python Package for Robot navigation algorithms.

Installation

The package is currently under development so we suggest installing from source.

From Source (Recommended)

git clone https://github.com/ERC-BPGC/gennav.git
cd gennav
python -m pip install .

Using pip

pip install gennav

Usage

To plan a path using the Rapidly-exploring random tree algorithm in a polygon based environment representation.

from gennav import planners, envs, utils
from gennav.utils import RobotState
from gennav.utils.geometry import Point
from gennav.utils.samplers import uniform_random_sampler as sampler


obstacles = []
env = envs.PolyEnv()
env.update(obstacles)

start = RobotState(position=Point(1, 1))
goal = RobotState(position=Point(10, 10))

palnner = RRT(sample_area=(-5, 15), sampler=sampler, expand_dis=0.1)
path = palnner.plan(start, goal, env)

Note that the environment have been left blank empty here, they should be updated as per use case.

For more details you can refer to our documentation.

Contributions

Contributions are always welcome. We reccomend you check out contribution guidelines and view the docs beforehand.

Project details


Download files

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

Source Distribution

gennav-0.1.1.tar.gz (15.1 kB view details)

Uploaded Source

File details

Details for the file gennav-0.1.1.tar.gz.

File metadata

  • Download URL: gennav-0.1.1.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.9

File hashes

Hashes for gennav-0.1.1.tar.gz
Algorithm Hash digest
SHA256 511bd45800ebb36883764f9c2a84f756539f21437f06a64244301278a85d3c11
MD5 5a1775a53bedeb5d9efdacd57532dc5d
BLAKE2b-256 3d5c5aa0954cc6c6d048a65356e64ee8fd6cdbf6862651d9a5b90b5aa39eadbf

See more details on using hashes here.

Supported by

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