aviary 1.0.1

No project description provided

Aviary -- NASA's aircraft design tool

Aviary is an aircraft analysis, design, and optimization tool built on top of the Python-based optimization framework OpenMDAO. Aviary incorporates aircraft sizing equations from its predecessors GASP (General Aviation Synthesis Program) and FLOPS (Flight Optimization System). There are two options for the mission analysis portion of this code, a two-degrees-of-freedom (2DOF) approach, and an energy-state approach. The user can select which type of mission analysis to use, as well as whether to use the FLOPS-based code or the GASP-based code for the weight, sizing, and aerodynamic relations. Aviary provides a flexible and user-friendly optimization platform for conceptual aircraft design. This tool is being used by college level senior design courses, NASA internally, a industry partners. Aviary is under active development! While the base features of the code are relatively stable, new releases may make changes that require users on the bleeding-edge to update their models.

If you are using Aviary, please Cite us!

Documentation

Read the Docs.

Overview Slide Slow is a great place to get started if you are wondering what Aviary is at a high level.

Overview Video gives a 5 minute introduction to Aviary.

Paper by Gratz et al. describing aviaries capabilities in detail.

How NASA uses aviary to model Aircraft by Aretskin-Hariton et al. describes how aviary was applied to model a Transonic Truss-Braced Wing (TTBW) aircraft.

Installation

Pip Install

The simplest installation method for users is to install via pip:

pip install aviary

Please see the installation doc page for more detailed instructions. The minimum supported Python version for Aviary is 3.9.

Docker Install

You can also install aviary as a package/image using docker:

docker pull ghcr.io/openmdao/aviary:latest

Validation

This code has been validated using output and data from the GASP and FLOPS codes themselves. The GASP-based weight calculations in this code include in their comments which versions of the GASP standalone weights module were used in validation. The aero and EOM subsystem validations were based on runs of the entire GASP and FLOPS code as they stood in the summer of 2021 and the summer of 2022 respectively.

Quick testing

The repository installation can be tested using the command testflo . at the top-level Aviary folder. If you have both SNOPT and IPOPT installed the output should look something like this:

    OK

    Passed:  706
    Failed:  0
    Skipped: 3


    Ran 709 tests using 16 processes
    Wall clock time:   00:00:16.97

Full testing

In addition to all of the quicker tests, we include multiple integration tests within Aviary. These have also been known as "benchmarks". Due to their length, these tests are not run when using the above command. Instead, you can use the run_all_benchmarks.py file in the Aviary/aviary folder, which is just a light wrapper around the testflo call. This will run all of the longer tests in parallel using all of your available CPU cores.

Package versions

Information on the versions of the packages required for Aviary can be found in the most recent GitHub Actions runs. We have also provided a static version of the environment.yml at the top level of the Aviary repo.

Contact Us

Get in touch with the Aviary team at [e-mail] or the GitHub discussions page

Citing Aviary

If you use Aviary in your research, please cite:

Gratz, J., Kirk, J., Recine, C., Jasa, J., Aretskin-Hariton, E., Moore, K., & Marfatia, K. (2024). Aviary: An Open-Source Multidisciplinary Design, Analysis, and Optimization Tool for Modeling Aircraft With Analytic Gradients. AIAA AVIATION FORUM AND ASCEND 2024. https://doi.org/10.2514/6.2024-4219

BibTeX

@inbook{doi:10.2514/6.2024-4219,
author = {Jennifer Gratz and Jason Kirk and Carl Recine and John Jasa and Eliot Aretskin-Hariton and Kenneth Moore and Kiran Marfatia},
title = {Aviary: An Open-Source Multidisciplinary Design, Analysis, and Optimization Tool for Modeling Aircraft With Analytic Gradients},
booktitle = {AIAA AVIATION FORUM AND ASCEND 2024},
doi = {10.2514/6.2024-4219},
URL = {https://arc.aiaa.org/doi/abs/10.2514/6.2024-4219},
year = {2024},
}

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jeff Chapman 💻 💡	crecine 💻 🔣 👀	dlcaldwelljr-ama-inc 💻 🚇 🧑‍🏫 👀	Eliot Aretskin-Hariton 💻 🔍 👀	Erik Olson 💻	DP 💡	gawrenn 💻 💡
hschilling 💻 🎨	Kenneth Lyons 💻 👀	Jennifer Gratz 💻 📖 📆 👀	Jason Kirk 💻 🔣 📖 👀	John Jasa 💻 📖 💡 👀 📹	Kenneth Moore 💻 🚇 👀	Rob Falck 🚇 🧑‍🏫
Ben Margolis 💻 🚇	swryan 💻 🚇	Xun Jiang 💻

This project follows the all-contributors specification. Contributions of any kind welcome!