GenNav
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.
Metadata
Release files for gennav 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| gennav-0.1.1.tar.gz | 15.1 kB | Without provenance | Details |
Security for gennav 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.