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 wheel numpy
pip3 install pyflyt

numpy and wheel must be installed prior to pyflyt such that pybullet is built with numpy support.

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

Uploaded Source

Built Distribution

PyFlyt-0.9.4-py3-none-any.whl (65.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.9.4.tar.gz
Algorithm Hash digest
SHA256 46e145183a467453116cf3234b33853bd7be65d58d2bb52a9528378fb22197f6
MD5 e8b520c5a94d6396d331474fcb597dba
BLAKE2b-256 da65a58ac237bdbaff01181226c942507222037c9492128850a96aa8e0e87afe

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1f9e5609985a5ff3c720cecf36353c8f81ecaf9569a904734acc62dd8e5da061
MD5 a2d9155210424205ed222905ea965122
BLAKE2b-256 ed0d6497e1e92b1318b663c50b349fa445f0a7fa033e112a60ad7040761947ee

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