Skip to main content
Ctrl+K
 - Home  - Home
  • Welcome to Aviary

Getting Started

  • Getting Started
  • Installation
  • Expected User Knowledge
  • Underlying Tools
  • What’s Next?

User Guide

  • Aviary Fundamentals
    • How Aviary Defines Variables
    • Aviary Input Files
      • Aircraft Definition
      • Mission Definition
      • Data Files
    • Outputted files and how to read them
    • User Interface Levels
  • Python API
  • Examples of the same mission at different UI levels
  • Command Line Tools
  • Drawing and running simple missions
  • Pre-Mission and Mission
  • Visualizing Results from Aviary
  • Features and Functionalities
  • Defining a Custom Variable Hierarchy
  • Subsystems
    • Aerodynamics Subsystem
      • Externally Computed Polars
    • Atmosphere Subsystem
    • Propulsion
      • Electric Motor Modelling
      • Hamilton Standard Propulsion Model
      • Creating a Turboprop Powered Aircraft Example
    • Mass Subsystem
      • Fuel Burn Calculations
      • GASP Based Blended Wing Body Modeling
      • FLOPS Based Blended Wing Body Modeling
    • External Subsystems
    • Step-by-step guide for creating, testing, and using external subsystems
    • In-depth look at the battery subsystem as an example
  • Overriding Variables
  • FLOPS Based Detailed Takeoff and Landing
  • Reserve Mission
  • Multi-Mission Optimization
  • Off-Design Missions
  • Payload Range Functionality.
  • Troubleshooting

Examples

  • Examples Outline
  • Running a Simple Mission
  • Running a Custom Optimization
  • Running a Reserve Mission
  • Optimizing the Mission Profile of a Conventional Aircraft
  • Off-Design Missions
  • 2DOF Detailed Takeoff and Landing
  • Multi-Mission Example
  • Creating and Using External Subsystems
  • Using Aviary and OpenAeroStruct Together
  • Aviary Model Without AviaryProblem

Theory Guide

  • Overview of Aviary Functionality
  • Underlying Concepts
    • Assumptions
    • Core Aerodynamics Subsystem
    • Core Geometry Subsystem
    • Core Mass Subsystem
    • Mission Analysis
    • Core Propulsion Subsystem
      • The Turboprop Model
  • Optimization Algorithms
  • Validation
  • Comparison to FLOPS
  • GASP based BWB model implementation

Developer Guide

  • Codebase Overview
  • Coding Standards
  • Aviary’s AI Policy
  • Unit Tests
  • Guidelines for Contributing Code
  • How to Contribute Docs
    • DocTAPE
    • DocTAPE Examples
  • Using Dev Environments from GitHub Actions

Source Docs

  • Understanding the Variable Metadata
  • Complete phase_info user options reference for all Aviary EquationsOfMotion
  • SubsystemBuilder
  • Source Docs

Miscellaneous Resources

  • Frequently Asked Questions
  • Resources
  • Converting from legacy phase_info user options
  • Repository
  • Open issue

Index

By Aviary team at NASA

© Copyright 2023.