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

Uploaded Source

Built Distribution

PyFlyt-0.7.4-py3-none-any.whl (179.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyFlyt-0.7.4.tar.gz
  • Upload date:
  • Size: 158.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.7.4.tar.gz
Algorithm Hash digest
SHA256 0b1a4db7fc6ef2425eb53f94da80cb9e87a8b7270bf1eea301e7d3763ae636cc
MD5 c1be3461a42dc786a6dfd88bcbcd6c97
BLAKE2b-256 70a2cd740e405d9232dc28a2d0406c87c2e4c8f347008214d93f19ccd8a4cf5a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 179.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3a3e3e959414ed812ad97534ae58035da08bc72a8f77895a050bbea56c4c2fcb
MD5 fdf294bb23f864343e2869cd23556463
BLAKE2b-256 c0ba9a51fd398f72672c0f168286cd1943a71eb677380c497951a6ca9fcbf069

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