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

Uploaded Source

Built Distribution

PyFlyt-0.8.4-py3-none-any.whl (180.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.8.4.tar.gz
Algorithm Hash digest
SHA256 c9d957223e2338d1751bfc6887eb6ab87d2c3c3cab265972ce7f65a6c2c2eb90
MD5 3c6f8e347711e58fdc7c798f139f254c
BLAKE2b-256 1e5d2bcb6ba30d520c48997c6ed12660966e99d17d9b32a0d9fce71a75e99910

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.8.4-py3-none-any.whl
  • Upload date:
  • Size: 180.0 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.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f6c7273f9b98717258942661a702926b9b1483033988d36de53bba507199cd8b
MD5 0567bbf321fd40654dd980303c9f45a6
BLAKE2b-256 42c73da179e0b875f3d2705d8eb3783d2f253583e801bb457c174efad7b0794b

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