README

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.

 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 usi

Top issues

Discussions

Latest release

What's Changed
 1.0.2-dev version increment by @jkirk5 in https://github.com/OpenMDAO/Aviary/pull/1214
 Cleaned up a warning message when using fixed throttle allocation for multi-engine. by @Kenneth-T-Moore in https://github.com/OpenMDAO/Aviary/pull/1207
 Moved the total nacelle wetted area calc into its own component. by @Kenneth-T-Moore in https://github.com/OpenMDAO/Aviary/pull/1210
 Remove ambiance dependency from OpenAeroStruct wing mass example by @zain-asif-dev in https://github.com/OpenMDAO/Aviary/pull/1216
 Simplified API for input/output helper functions by @jkirk5 in https://g