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

Uploaded Source

Built Distribution

PyFlyt-0.15.4-py3-none-any.whl (196.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.15.4.tar.gz
Algorithm Hash digest
SHA256 929b896fbce0be62c377acde5550cdbc0764da0cff0c2e2a789c784109daaebb
MD5 82c0e9b5c2ee3e19d9a74c3dc1331d6d
BLAKE2b-256 1053f61d07488ab8632580877e00f95b6e8191e67075796b5b03eb71a076532f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.15.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ba4c368eea07737af0d48027a847454af544907bd9257194cb22f97a8e5a2f71
MD5 fb1034f9eac357acc675122f6d7ac49d
BLAKE2b-256 aa7805373f9076c971ebfd481b8dbe6311c4e5180ee0360d0978c717e5c260d8

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