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

Uploaded Source

Built Distribution

PyFlyt-0.6.6-py3-none-any.whl (178.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.6.6.tar.gz
  • Upload date:
  • Size: 157.2 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.6.tar.gz
Algorithm Hash digest
SHA256 60825c56f0004e1a6bb31711d8d9613bba7e09815d5f218d28f0e0780a55aa15
MD5 d007865abcbfd45f255b1596ba040d0e
BLAKE2b-256 032fa4bdb70a3b0031a2c5e1ec88f09e8f7f27879835c6c8aeef4977a82d9258

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.6.6-py3-none-any.whl
  • Upload date:
  • Size: 178.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4910e5578f6d5e798aa62c9136c386359a68b2fd4f9f2c9514b8416454decedd
MD5 d358e88c5db7516f90c6c6e8a006896e
BLAKE2b-256 60342cbe0fbf5057c8156cb57124000edc1411ea3e9bf0a92adb3f500f80e95e

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