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 pyflyt

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.7.5.tar.gz (158.4 kB view details)

Uploaded Source

Built Distribution

PyFlyt-0.7.5-py3-none-any.whl (179.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.7.5.tar.gz
  • Upload date:
  • Size: 158.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for PyFlyt-0.7.5.tar.gz
Algorithm Hash digest
SHA256 1abfdd1370af3fe199f9dec1ab925f7687fbbcf91e689845b110ce76d62f5978
MD5 bb855f887fe8190bb4627bb73c9cec5e
BLAKE2b-256 593d6ab0364fbcfbe1995ad6a4bb2ab71aef45e7d981b1ace9294cea0ccd6c69

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.7.5-py3-none-any.whl
  • Upload date:
  • Size: 179.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for PyFlyt-0.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 436fad3342f7da0633df95dc6ab75507229315d6dca08c66f977c885d4f37111
MD5 c0f1389961219ff22c1d2de7dfc9d5fb
BLAKE2b-256 c0c4b345abd8df68892c1a929d40be18a7601e7249683e076d09ac426bde2168

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