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

Uploaded Source

Built Distribution

PyFlyt-0.14.0-py3-none-any.whl (188.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.14.0.tar.gz
  • Upload date:
  • Size: 165.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.14.0.tar.gz
Algorithm Hash digest
SHA256 46875f77e2c107ea290a716ed15c8d8f7d78ef5f817448adc67edb54b53abbbb
MD5 f48ff94673e4c686aa35ac7134af3fe8
BLAKE2b-256 7c794a4dfb84e640841a5f7fd2a96e6738b379b86b0b370baaab0e7ea8b50aa6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 188.2 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.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 570220e58321e97cda7c357475f7fe8bd20b3c3aa1fa3a32c23c206ee3142689
MD5 150cf3fc476e3484d78618bcd86a3615
BLAKE2b-256 e7a9a2e37eeca5bf53d866144fbd9b7ca0e1bee3252803983f528ebb4167c18d

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