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

Uploaded Source

Built Distribution

PyFlyt-0.7.1-py3-none-any.whl (178.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.7.1.tar.gz
Algorithm Hash digest
SHA256 41e1e046b847c74f1ee782715f8a6d9fb59da2a17139d4f2e45d5d5209af324e
MD5 f7b992bf600ffa6a53eb6ce0f239824d
BLAKE2b-256 ef71b2b61e5e0336e23331ddd8c6a41c352de4cda02cd7cf289fe397f1a291d3

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: PyFlyt-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 178.7 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.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef88710ba9071a34faaabfc4c0ebc16b77fee5593be83965fed8fe6e8c5759d4
MD5 b0e5d8c43cd7c6cff491ba9e1704da0d
BLAKE2b-256 9dce9a340632f604d7f067d9f15afaba28313f6fb2e8985739ce8dc8c92f998c

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