Skip to main content

UAV Flight Simulator Gymnasium Environments for Reinforcement Learning Research.

Project description

PyFlyt - UAV Flight Simulator for Reinforcement Learning

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}
}

Gallery

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

Uploaded Source

Built Distribution

PyFlyt-0.27.0-py3-none-any.whl (214.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyflyt-0.27.0.tar.gz
  • Upload date:
  • Size: 183.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pyflyt-0.27.0.tar.gz
Algorithm Hash digest
SHA256 37e50449289ceeb8597bbedcbc8654b306172a4a9ab317b83754c6d9f90d3ef0
MD5 0c3f0ede04038b32938ac806be40b9e9
BLAKE2b-256 01631efab402cbe29ad0d2abf7515a51ab62090ee0e54c7fdc6dc1d1cf9e28c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.27.0-py3-none-any.whl
  • Upload date:
  • Size: 214.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for PyFlyt-0.27.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c51d1f6726e21fc49d51a8c0388dab1f8a3e05633c1e6fb1517beda3249bc5a
MD5 21fb8ca4a4c67b32c3c5578882a7a523
BLAKE2b-256 d669c6c1cb38874483ee827cd744d5aa84f7ff4cc20059cb39f3662aebee3736

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