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

Uploaded Source

Built Distribution

PyFlyt-0.6.7-py3-none-any.whl (178.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.6.7.tar.gz
  • Upload date:
  • Size: 157.6 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.7.tar.gz
Algorithm Hash digest
SHA256 8c0d2c4f246aa9fc159c7eb7822eef88765f1b8fe67b1a494017a1d73d34f8a2
MD5 18a5734c11b77d4a86a3e0cdfffb3e96
BLAKE2b-256 ea0b0d530d569d6af23f931db0033ef63512894fb531591ccfc601371b70dbbc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.6.7-py3-none-any.whl
  • Upload date:
  • Size: 178.5 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 199a6ab76b313d49f888459d12360561cb26f3f0adfb9c474959bf4b4313f074
MD5 0dcc5f6da61b28ce46413db599331c21
BLAKE2b-256 7f1f2e2f17bf4afd07ca9199074c910549190d551b645a12aeb2ff0767964ba3

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