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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.9.3.tar.gz
Algorithm Hash digest
SHA256 a846e2f2c436de410433dccd70555ec20f80e738b640f4adcee030d02fae188d
MD5 aaaababd6e8a636273cea3c6aa85ffc2
BLAKE2b-256 b7d5c0d88b0f84ee0491ec70b13910bd9ef830bde46893732be9d7946072cba5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 60053e970fdaa2ac547016d6df023caa42aa318a1b370f3c937374c90f3c784e
MD5 e68990876d67c07f5b1dff067775be86
BLAKE2b-256 55b1e0450450daeaa97266df82a326c7a9f1516c47cf56c718e6dd1320d033db

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