Skip to main content
Ctrl+K
Logo image Logo image

Site Navigation

  • Getting Started
  • Basic User Guide
  • Advanced User Guide
  • Theory Manual
  • Features
  • Examples
  • Command Line Tools
  • How to Cite OpenMDAO
  • Building a Tool on Top of OpenMDAO
  • 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)

Site Navigation

  • Getting Started
  • Basic User Guide
  • Advanced User Guide
  • Theory Manual
  • Features
  • Examples
  • Command Line Tools
  • How to Cite OpenMDAO
  • Building a Tool on Top of OpenMDAO
  • 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)
Logo image Logo image
Ctrl+K

Getting Started

  • Getting Started

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
    • Recording Data
    • Model Visualization
    • Debugging
    • Warning Control
    • Units Definitions
    • Experimental Features
  • 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

Quick Reference: OpenMDAO-Related Environment Variables

Contents

  • User-Facing Environment Variables

Quick Reference: OpenMDAO-Related Environment Variables#

In some cases, the way in which OpenMDAO operates is up to the preferences of the user. At this time, rather than using a preferences file, these optional OpenMDAO behaviors are based on the values of environment variables.

Some of these environment variables are interpreted as either being “truthy” or “falsey”. For OpenMDAO, an environment variable is considered False if it takes on one of the following values:

  • ‘0’

  • ‘false’

  • ‘no’

  • ‘off’

  • ‘none’

  • ‘’

These are all string values and OpenMDAO interprets them in a case-insensitive way. Note that, for OpenMDAO, the empty string means that an unset environment variable will be interpreted as False.

Any other environment variable value other than those above is interpreted as True.

User-Facing Environment Variables#

Environment Variable

Description

See Also

OPENMDAO_INVALID_DESVAR_BEHAVIOR

Specifies default driver behavior if the initial design variables are out of bounds.

Paraboloid

OPENMDAO_REPORTS

May be boolean-like or the names of the desired reports to be generated.

Reports

OPENMDAO_USE_MPI

Set to True to force an exception when MPI is needed but mpi4py is unavailable.

Controlling MPI

OPENMDAO_WORKDIR

Top-level directory for OpenMDAO outputs. Defaults to current working directory if not set.

Reports System

OPENMDAO_NO_RELEVANCE

Turns off relevance. Sometimes useful when debugging OpenMDAO internals.

OPENMDAO_DUMP

Dumps trace information and/or output of om_dump function to file, optionally by rank and/or PID.

OPENMDAO_DISABLE_RICH

Prevents OpenMDAO from using colorized output with the rich python package.

USE_PROC_FILES

Set to True to cause stdout/err from each MPI process to be written to [rank].out.

Controlling MPI

OMPI_MCA_rmaps_base_oversubscribe

Set to ‘1’ to fix there are not enough slots available in the system issue for some versions of MPI.

Controlling MPI

OMPI_MCA_btl=self,tcp

Set to ‘self,tcp’ to fix A system call failed during shared memory initialization that should not have… error in some version of MPI

Controlling MPI

previous

Upgrading from OpenMDAO 2.10 to OpenMDAO 3

next

File Wrapping

On this page
  • User-Facing Environment Variables

By The OpenMDAO Development Team

© Copyright 2022.

Last updated on None.