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

Uploaded Source

Built Distribution

PyFlyt-0.13.0-py3-none-any.whl (183.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.13.0.tar.gz
Algorithm Hash digest
SHA256 f2c146c881186e2f826b8e3df8d0441685a16335835c57ead540cf2bd8425a56
MD5 c0afec292c71be8a9e1efa13232bd30a
BLAKE2b-256 ed0c96b6f3cabb3c8c611cf2036672c8d66b835dbdf548107cd65eddd6a5f9be

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b66686ef532e8df5eb9bc94923c8637e3cd5d3c57593abcb3d28c7b4e8961500
MD5 cf8e9505f507a00027ef0949ddd1afc4
BLAKE2b-256 676fe926d23189867a79566ccff095921f334dfe2bee45890a9661dea8cc24e6

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