Skip to main content

UAV Flight Simulator Gymnasium Environments for Reinforcement Learning Research.

Project description

GitHub CI pre-commit hits total downloads weekly downloads

PyFlyt - UAV Flight Simulator Gymnasium Environments for Reinforcement Learning Research

View the documentation here!

This is a library for testing reinforcement learning algorithms on UAVs. This repo is still under development. We are also actively looking for users and developers, if this sounds like you, don't hesitate to get in touch!

Installation

pip3 install wheel numpy
pip3 install pyflyt

numpy and wheel must be installed prior to pyflyt such that pybullet is built with numpy support.

Usage

Usage is similar to any other Gymnasium and (soon) PettingZoo environment:

import gymnasium
import PyFlyt.gym_envs # noqa

env = gymnasium.make("PyFlyt/QuadX-Hover-v0", render_mode="human")
obs = env.reset()

termination = False
truncation = False

while not termination or truncation:
    observation, reward, termination, truncation, info = env.step(env.action_space.sample())

View the official documentation for gymnasium environments here.

Citation

If you use our work in your research and would like to cite it, please use the following bibtex entry:

@article{tai2023pyflyt,
  title={PyFlyt--UAV Simulation Environments for Reinforcement Learning Research},
  author={Tai, Jun Jet and Wong, Jim and Innocente, Mauro and Horri, Nadjim and Brusey, James and Phang, Swee King},
  journal={arXiv preprint arXiv:2304.01305},
  year={2023}
}

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

PyFlyt-0.11.0.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

PyFlyt-0.11.0-py3-none-any.whl (66.9 kB view details)

Uploaded Python 3

File details

Details for the file PyFlyt-0.11.0.tar.gz.

File metadata

  • Download URL: PyFlyt-0.11.0.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for PyFlyt-0.11.0.tar.gz
Algorithm Hash digest
SHA256 2e4fff16239481090b890accc9e8385aa4dd22f086667a6b94649336895e4246
MD5 0e812b326d3ba7b4b700ac2974edb3bd
BLAKE2b-256 c1f67504c307ff30f663c063ef0493b505495ece082fbef33133efa93be3f945

See more details on using hashes here.

File details

Details for the file PyFlyt-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: PyFlyt-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 66.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for PyFlyt-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f39b3a06b664a8abfffec776fce58d46bb1a9cb84ca3ec0ba3552425f6df26c6
MD5 06e3ab0586ad9c1759e0bcab3ccaae5b
BLAKE2b-256 e487771ae78ff786231ae00a67269184c42bbdda577f0f67df6095284cfa2e38

See more details on using hashes here.

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