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

Uploaded Source

Built Distribution

PyFlyt-0.9.2-py3-none-any.whl (65.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.9.2.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.2.tar.gz
Algorithm Hash digest
SHA256 14cfcfc556db4feaec4e2efd8228b1b600fce3b4a1a1c06505e0790daf9e30f3
MD5 11d35de3428dc16a2fcb489d20fd3a3e
BLAKE2b-256 c0006683824dd0af152968adfcde403f16a04202b0cb3e737de7df23832a6478

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 65.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9ed7ebf0102b21111a56659c5510784cb7d9a9470e6848759d93c45d9461402a
MD5 f11bf0a8b0b90206a9e0d7eab54a26b9
BLAKE2b-256 e5bbd1dec4c55555646eeeb29ec229a05fa5c393ee914f4e5a4be84d9f49a0b0

See more details on using hashes here.

Provenance

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