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

Uploaded Source

Built Distribution

PyFlyt-0.6.5-py3-none-any.whl (177.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.6.5.tar.gz
Algorithm Hash digest
SHA256 0995ef864efa5ac62a4212d720adfe4693e25329e90ee43ab0e455d0a0660721
MD5 5dd0d894ca67445efaf9db01be8aebc5
BLAKE2b-256 04932ccec84ae12c4c1bbd17ab560ed9920420d40231d9079f8ff0d01813bbb8

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 177.0 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.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ed9e3fb17704401c9732877aac8ab20d626b1d5e9cde65eaa017649831e0006f
MD5 de9570cf97ba09b47d817bdc09244679
BLAKE2b-256 bf08c86581bb99120831ba0565fbd97f554580f1d61b1ab89d1966df4982525b

See more details on using hashes here.

Provenance

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