flyerenv

A gymnaisum environment for autonomous decision making in fixed-wing aircraft

https://github.com/aos55/flyerenv

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary

Keywords

aerospace-simulator autonomous-vehicles gym-environment machine-learning reinforcement-learning
Last synced: 10 months ago · JSON representation ·

Repository

A gymnaisum environment for autonomous decision making in fixed-wing aircraft

Basic Info
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 9
  • Releases: 0
Topics
aerospace-simulator autonomous-vehicles gym-environment machine-learning reinforcement-learning
Created over 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

FlyerEnv

build

A gymnasium environment for autonomous decision-making in fixed-wing aircraft

The Environments

Point Navigation

python env = gymnasium.make("flyer-v1")

In this task the aircraft must navigate to a specified 3D goal point in space in the shortest possible time.

Trajectory Following

python env = gymnasium.make("trajectory-v1")


Trajectory Following

In this task the aircraft must follow a trajectory created by a moving target, maintaining on target maximizes the reward. The possible trajectory primitives are as follows: - sl, maintain straight and level flight. - climb, climb to a specified level at a fixed climb angle. - descend, descend to a specified level at a fixed descent angle. - lt, turn left to a specified heading at a fixed rate. - rt, turn right to a specified heading at a fixed rate.

Runway Landing

python env = gymnasium.make("runway-v1")


Runway Landing

In this task the aircraft needs to navigate to a runway to land.

Forced Landing

python env = gymnasium.make("forced_landing-v1")


Forced Landing

In this task the aircraft needs to find a suitable landing spot in an unprepared location.

Installation

pip install flyer-env

Usage

```python import gymnasium as gym

env = gym.make("flyer-v1", render_mode="human")

done = truncated = False while not (done or truncated): action = ... # Your agent code goes here obs, reward, done, truncated, info = env.step(action) ```

Documentation

Read the documentation: https://aos55.github.io/FlyerEnv/

Citing

If you use the project in your work, please consider citing it with:

text @misc{flyer-env, author={Quessy, Alexander}, title={An Environment for Autonomous Fixed-Wing Guidance, Navigation and Control Tasks}, year={2023}, publisher={GitHub}, journal={GitHub repository}, howpublished={\url{https://github.com/AOS55/flyer-env}}, }

Owner

  • Name: Alexander Quessy
  • Login: AOS55
  • Kind: user
  • Location: Bristol, United Kingdom
  • Company: Bristol University

University of Bristol PhD Student researching Deep Reinforcement Learning and Machine Learning for Aerial Robotics

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Quessy"
  given-names: "Alexander"
title: "An Environment for Autonomous GNC of FixedWing Aircraft"
version: 0.1
date-released: 2023-10-01
url: "https://github.com/AOS55/FlyerEnv"

GitHub Events

Total
  • Issues event: 1
  • Watch event: 2
  • Issue comment event: 1
  • Push event: 23
  • Create event: 2
Last Year
  • Issues event: 1
  • Watch event: 2
  • Issue comment event: 1
  • Push event: 23
  • Create event: 2

Dependencies

.github/workflows/bulid-testing-onprem.yml actions
  • PyO3/maturin-action v1.42.0 composite
  • actions/checkout v2 composite
  • actions/setup-python v3 composite
.github/workflows/build-docs-dev.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/build-docs-version.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • dawidd6/action-get-tag v1 composite
.github/workflows/build.yml actions
  • PyO3/maturin-action v1.42.0 composite
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
.github/workflows/manual-build-docs-version.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/pre-commit.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
docs/requirements.txt pypi
  • furo *
  • gymnasium *
  • ipykernel *
  • jupyter-sphinx *
  • matplotlib *
  • myst-parser *
  • python-docs-theme *
  • sphinx *
  • sphinx-autobuild *
  • sphinx_github_changelog *
  • sphinxcontrib-bibtex *
  • sphinxcontrib-mermaid *
pyproject.toml pypi
setup.py pypi