Skip to main content

UAV Flight Simulator Gymnasium Environments for Reinforcement Learning Research.

Project description

Ruff total downloads weekly downloads

PyFlyt - UAV Flight Simulator for Reinforcement Learning Research

Comes with Gymnasium and PettingZoo environments built in!

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 PettingZoo environment:

Gymnasium

import gymnasium
import PyFlyt.gym_envs # noqa

env = gymnasium.make("PyFlyt/QuadX-Hover-v2", 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.

PettingZoo

from PyFlyt.pz_envs import MAFixedwingDogfightEnv

env = MAFixedwingDogfightEnv(render_mode="human")
observations, infos = env.reset()

while env.agents:
    # this is where you would insert your policy
    actions = {agent: env.action_space(agent).sample() for agent in env.agents}

    observations, rewards, terminations, truncations, infos = env.step(actions)
env.close()

View the official documentation for pettingzoo 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.22.2.tar.gz (171.6 kB view details)

Uploaded Source

Built Distribution

PyFlyt-0.22.2-py3-none-any.whl (200.0 kB view details)

Uploaded Python 3

File details

Details for the file pyflyt-0.22.2.tar.gz.

File metadata

  • Download URL: pyflyt-0.22.2.tar.gz
  • Upload date:
  • Size: 171.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for pyflyt-0.22.2.tar.gz
Algorithm Hash digest
SHA256 bbbaae9ea2d90bb87a75e65f3a673c04f0129ceac52d128620fb45dc6c279f2c
MD5 b3ca4967357e120e6e3d4811834c11eb
BLAKE2b-256 c500914bc6bdda96c86cd048e69c369c0603222b7b5e2d99f159a60bc5c1ec31

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.22.2-py3-none-any.whl
  • Upload date:
  • Size: 200.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for PyFlyt-0.22.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f9cbf57d4c8b7fb7097254683ee4338e9d9cadc8ee8b9d8f94eecd871ca4502f
MD5 686e7a46e6e0639920670a72df1d3d70
BLAKE2b-256 3b7ce0bcb7b76ad1c4b21576b928f62d47b1a9a67bfa47426dd8f79d5e2ce78d

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