Skip to main content
Include Source Docs
Ctrl+K
OpenMDAO documentation - Home

Getting Started

  • Getting Started
    • Using Pixi for reproducible environments

Basic User Guide

  • Basic User Guide
    • How OpenMDAO Represents Variables
    • Paraboloid - A Single-Discipline Model
    • Optimization of Paraboloid
    • Sellar - A Two-Discipline Problem with a Nonlinear Solver
    • Linking Variables with Promotion vs. Connection
    • Optimizing the Sellar Problem
    • Sanity Checking Your Model
    • Visualizing The Structure of Your Model
    • Basic Recording Example

Advanced User Guide

  • Advanced User Guide
    • Building Models with Solvers and Implicit Components
    • Using BalanceComp to Create Implicit Relationships in Groups
    • Computing Total Derivatives of Coupled Models
    • Defining Partial Derivatives on Implicit Components
    • Defining Partial Derivatives on Explicit Components
    • Advanced Recording Example
    • Cannonball Example with Euler Integration and an External Optimizer
    • A Guide to Using Complex Step to Compute Derivatives
    • Raising an AnalysisError

Reference Guide

  • Theory Manual
    • OpenMDAO Class Structure
    • Understanding How Variables Work
    • The System Setup Stack: Understanding When to Use setup and configure
    • OpenMDAO Solvers
    • Scaling Variables in OpenMDAO
    • Determining How Many Times a System was Executed
    • How Total Derivatives are Computed
    • Setting Up a Model for Efficient Linear Solves
    • Advanced Linear Solver Algorithms for Special Cases
    • Using OpenMDAO with MPI
  • Features
    • Core Features
    • Building Blocks
      • Components
      • Drivers
        • Autoscaler API
      • Solvers
      • SurrogateModels
      • Function Metadata API
      • Composable functions via jax (openmdao.jax)
    • Recording Data
    • Model Visualization
    • Debugging
      • MPI Debugging with VS Code
      • Listing Variables
      • Solver Debug Printing
      • Debugging Your Optimizations
      • The Newton Solver Isn’t Converging
      • Controlling MPI Detection
      • Driver Debug Printing
      • Profiling and Tracing
    • Warning Control
    • Units Definitions
    • Experimental Features
      • Determining Variable Shapes at Runtime
      • Simultaneous Coloring of Approximated Derivatives
      • Working with Plugins
      • Moving Some Systems Outside of the Optimization Loop
      • Automatic Setting of Execution Order
      • Computing Partial Derivatives of Components Using JAX
      • What is Julia?
      • Using CSDL Components
      • OpenMDAO Problem Functional Interface
      • Determining Variable Units at Runtime
      • Computing Partial Derivatives using JaxExplicitComponent
      • Computing Partial Derivatives using JaxImplicitComponent
  • Examples
    • Optimizing a Paraboloid – The TL;DR Version
    • Simple Optimization
    • Wind Turbine Actuator Disc
    • Hohmann Transfer Example - Optimizing a Spacecraft Manuever
    • Kepler’s Equation
    • Converging an Implicit Model: Nonlinear circuit analysis
    • Optimizing the Thickness Distribution of a Cantilever Beam Using the Adjoint Method
    • Revisiting the Beam Problem - Minimizing Stress with KS Constraints and BSplines
    • Simple Optimization using Simultaneous Derivatives

Other Useful Docs

  • Command Line Tools
  • How to Cite OpenMDAO
  • Building a Tool on Top of OpenMDAO
    • Repository Structure
    • Release Your Project on pypi
  • Conversion Guide for the Auto-IVC (IndepVarComp) Feature
  • Upgrading from OpenMDAO 2.10 to OpenMDAO 3
  • Quick Reference: OpenMDAO-Related Environment Variables
  • File Wrapping
  • Source Docs
  • Developer Docs (if you’re going to contribute code)
    • Signing GitHub Commits
    • Unit Testing
    • Continuous Integration Testing
    • Local Building of OpenMDAO Documentation
    • OpenMDAO Docs Style Guide
    • Sphinx and Decorated Methods
    • Writing Plugins
  • .ipynb

openmdao.core#

  • analysis_error

  • component

  • configinfo

  • conn_graph

  • constants

  • driver

  • explicitcomponent

  • functional_callback

  • group

  • implicitcomponent

  • indepvarcomp

  • parallel_group

  • problem

  • system

  • total_jac

By The OpenMDAO Development Team

© Copyright 2026, OpenMDAO Development Team.