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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

PyFlyt-0.11.1-py3-none-any.whl (182.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.11.1.tar.gz
  • Upload date:
  • Size: 160.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.12

File hashes

Hashes for PyFlyt-0.11.1.tar.gz
Algorithm Hash digest
SHA256 b2cef85e91e486cf2c37c6860a885c0381b21d51e697954533918fc80e3ea771
MD5 0985ea8ec9f6591c7e19ff49a1dbe440
BLAKE2b-256 ee3cb8dd3eababf39a0782eb942914a35c3843b2e166c8e6146e124727ebd163

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 182.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.12

File hashes

Hashes for PyFlyt-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bdb571d722ef122e56ad9d4ffdc41833232241df56935b56966f6de0a5abbd90
MD5 967cb93bafcb8abd34f2549ae347100c
BLAKE2b-256 1c9a5170b128a7d29e426ad45f4b5bbc15807d8a019fa5d3a52e452b705e8165

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page