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

Uploaded Source

Built Distribution

PyFlyt-0.9.5-py3-none-any.whl (180.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.9.5.tar.gz
Algorithm Hash digest
SHA256 c4a6a130e8406aca9c9b9fd8759c7a70481c76e9707e22ac882c3f9f3c66ef23
MD5 2d4ee1e7623d75e1be98cbe2a2d37ac2
BLAKE2b-256 b4578a1fbdbd9df0426eecb1b94bd4f4c3ff235fadbeac9f621bd46cc3b31607

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 11d5aac668b2d0777e51c1a68210452c5291ae61e03f9e7d70292c2de506a9d9
MD5 c9793d2d3ea534471ee1fc05b2eae868
BLAKE2b-256 d7e59d5545bc2d47402e781f8f75dcc6dd93e2b949073fcd1732f00ac03d7bf3

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