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 pyflyt

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.7.9.tar.gz
Algorithm Hash digest
SHA256 013286c34004af1858f965c7e521111d4a83c88e063373717e868619d83344ad
MD5 cdf19c0f1844472b26212f962de0e803
BLAKE2b-256 76263d2a7cf9864e12e018f6bcb2bfca53f0f701d65174dd922a848fe5803484

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.7.9-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.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 cd110bf71567a050a1b4cbd485c8eed6044f1a13c832d9d9c1a0cbc1523e5b4f
MD5 c288572fc97c20aa47b5f79aaed4dce3
BLAKE2b-256 b19c947618adcd088297cc6e1c4c94a1c3936ecdd5e4a90d2de10fab148cb814

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