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

Uploaded Source

Built Distribution

PyFlyt-0.7.2-py3-none-any.whl (179.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.7.2.tar.gz
Algorithm Hash digest
SHA256 ef08876e7e20b39bfd81c80fcac9862c2986bba2f630611747eb021209f1a2b1
MD5 952928903e7cdf663e7a17f2e6a429ff
BLAKE2b-256 2706ae9138ef6190b8dc42cf7dd039fb655e041bcdadc34834adc86f6face15b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 030a82d1756213fe7514bb26ca1959da6cb7598222249cda9abce7ff5008a819
MD5 ebc48db78d8acc03031cb722b6bffdd7
BLAKE2b-256 6b94b30e90451673e3619c18680e14d9d76c34d5f23e76807e93b8ec518fe729

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