General documentation

Here you will find the first things to know about FAST-OAD.

• Installation
• Process overview
  • How it works
  • Overview of FAST-OAD files
    • configuration file (.yml)
    • The input and output data files (.xml)
• Usage
  • FAST-OAD configuration file
    • Custom module path
    • Input and output files
    • Problem driver
    • Solvers
    • Problem definition
    • Optimization settings
      • Design variables
      • Objective function
      • Constraints
  • Advanced configuration
    • Imports
      • Extending sys.path
    • Driver settings
      • Standard Syntax
      • Advanced Syntax
    • Model options
  • Using FAST-OAD through Command line
    • How to get information about available plugins
    • How to generate a configuration file
    • How to get list of registered modules
    • How to get list of variables
    • How to generate an input file
    • How to generate a source data file
    • How to view the problem process
      • N2 diagram
      • XDSM
    • How to run the problem
      • Run Multi-Disciplinary Analysis
      • Run Multi-Disciplinary Optimization
  • Using FAST-OAD through Python
• Process variables
  • Variable naming
  • Serialization
    • File format
    • FAST-OAD API
• Mission computation
  • Defining missions
    • Mission file
      • General description
      • File sections
      • Factorizing parameters
    • Flight segments
      • Segment types
      • Special segment parameters
    • Setting values
      • hard-coded value and unit
      • hard-coded value with no unit
      • OpenMDAO variable
      • Contextual OpenMDAO variable
  • Configuring mission computation in FAST-OAD process
    • Inputs and outputs of the module
    • Usage in FAST-OAD configuration file
      • propulsion_id
      • mission_file_path
      • out_file
      • mission_name
      • use_initializer_iteration
      • adjust_fuel
      • compute_TOW
      • add_solver
      • is_sizing
  • Extensibility
    • Adding segment types
      • Links between Python implementation and mission definition file
      • Implementation of a segment class
    • The FlightPoint class
      • Available flight parameters
      • Exchanges with pandas DataFrame
      • Extensibility
• Custom modules
  • How to add your modules
    • Create your OpenMDAO system
      • Variable naming
      • Defining options
      • Definition of partial derivatives
      • About ImplicitComponent classes
      • The CycleGroup class
      • Checking validity domains
    • Register your system(s)
    • Modify the configuration file
  • Adding a propulsion module
    • The IPropulsion interface
      • Computation of propulsion data
      • Computation of consumed mass
    • The OpenMDAO wrapper
      • Defining the wrapper
      • Registering the wrapper
      • Using the wrapper in the configuration file
  • Documenting variables
    • Defining variable description in your OpenMDAO component
    • Defining variable description in dedicated files
  • Sharing your modules as a FAST-OAD plugin
    • Plugin structure
    • Plugin packaging
      • Plugin declaration
      • Building
      • Publishing
  • Using submodels (experimental)
    • Why submodels ?
    • How to use submodels in a custom module ?
    • How to declare a custom submodel ?
    • How to select submodels
      • Using configuration file (recommended)
      • Using Python
    • Deactivating a submodel