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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.6.4.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.4.tar.gz
Algorithm Hash digest
SHA256 12c03f29f38f864fe99c40dc740c99af645b316f8b0d77abc019e39d3ca05b83
MD5 cdc95dfbb994514a3597932162558946
BLAKE2b-256 1268d9df1582d4358b349ad6e60c78dc720d4a27d9fe4dc57a40b366e9d1983d

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.6.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 98d043ea888d74934db8fe9939211a91aafc24a713b3490a5c2d04049595e9d1
MD5 7b32eb9eb558945017935a798dbc4473
BLAKE2b-256 c261b47f405900e1595c34a2dceca64ec27db537269d5141977e171f9c6b3c8d

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