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

Gymnasium

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.

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

Uploaded Source

Built Distribution

PyFlyt-0.15.7-py3-none-any.whl (197.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyFlyt-0.15.7.tar.gz
Algorithm Hash digest
SHA256 eb8ecbc829c236958c8822fb725d24235c9d3a1e4d68749fb728332f487d544e
MD5 f063213b5edc92f2aafb5182829fe0e0
BLAKE2b-256 25d902642dba4adf78976ef96f844af058c643270411adb8e7a94023aed82666

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyFlyt-0.15.7-py3-none-any.whl
  • Upload date:
  • Size: 197.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for PyFlyt-0.15.7-py3-none-any.whl
Algorithm Hash digest
SHA256 563b2ad114fa89086e2a8efba8a6a361caf170140488e05fb5e3dde058980b59
MD5 ed2e89b3b5385da259ff4d0b28343f4a
BLAKE2b-256 cb490346b1b2f12babdad5ac1faf61ec1539c215e6675c70917059d4ad423472

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