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

Uploaded Source

Built Distribution

PyFlyt-0.10.0-py3-none-any.whl (180.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.10.0.tar.gz
  • Upload date:
  • Size: 159.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.10.0.tar.gz
Algorithm Hash digest
SHA256 8885bb874f20dec574672409d8d0c93a93bf189fca1e0481b5eaf3d33edf4bd2
MD5 ae877d37990d1214f1d80dbaa46e18f6
BLAKE2b-256 957375dfec50331392f6929353f71b0b6010171a13b43c06734fc7a7f2e62a9d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 180.8 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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2fa7082766e815b66e10700eee5dcdb5f8236d4cc4519d997f8ab840f1b2b9e7
MD5 fd0ffce90bba6f52a236ffd8c153c0c3
BLAKE2b-256 df54c9028b2954c27f674c4eca8ca41df2d2e8aea46a4a40ca7aad6c1737c23c

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