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

Uploaded Source

Built Distribution

PyFlyt-0.8.2-py3-none-any.whl (180.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.8.2.tar.gz
Algorithm Hash digest
SHA256 83fff75cfa4f90ab8de24f25ca5d5cd89809e8691ffc1e1a823effd7df2c63e0
MD5 704c502a03dc912c73136a9695762bc5
BLAKE2b-256 7151f302f009edf0b1fe3b1e2f623d822f1a83334fa37e5345d00d73c4fd48a2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 180.2 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.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e407be8172ed6682f66ae3ce13fea786afb371fadcc6a537f8c1b7443f701de5
MD5 25264c1e333d23ee333aa893ffd6c549
BLAKE2b-256 5848c365b3d2fb8e31a8c77a43ce7023e2328d8974a30e14bdf68be0c13afccb

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