Conflicts

.github/workflows/test_benchmarks.yml

@@ -18,7 +18,7 @@ on:
 jobs:
 
   latest_benchmarks:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     timeout-minutes: 90
 
     steps:
@@ -38,8 +38,7 @@ jobs:
             SCIPY: 1
             PYOPTSPARSE: 'v2.9.1'
             SNOPT: '7.7'
-            #OPENMDAO: 'latest'
-            OPENMDAO: '3.34.2'
+            OPENMDAO: 'latest'
             DYMOS: 'latest'
             SSH_PRIVATE_KEY: ${{secrets.SSH_PRIVATE_KEY}}
             SSH_KNOWN_HOSTS: ${{secrets.SSH_KNOWN_HOSTS}}

.github/workflows/test_docs.yml

@@ -18,7 +18,7 @@ on:
 jobs:
 
   latest_docs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     timeout-minutes: 90
 
     steps:
@@ -38,8 +38,7 @@ jobs:
             SCIPY: 1
             PYOPTSPARSE: 'v2.9.1'
             SNOPT: '7.7'
-            #OPENMDAO: 'latest'
-            OPENMDAO: '3.34.2'
+            OPENMDAO: 'latest'
             DYMOS: 'latest'
             SSH_PRIVATE_KEY: ${{secrets.SSH_PRIVATE_KEY}}
             SSH_KNOWN_HOSTS: ${{secrets.SSH_KNOWN_HOSTS}}

.github/workflows/test_workflow.yml

@@ -18,7 +18,7 @@ jobs:
 
   pre_commit:
     # run pre-commit checks
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v4
@@ -28,19 +28,20 @@ jobs:
     - uses: pre-commit/[email protected]
 
   test_ubuntu:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
         include:
           # oldest versions of openmdao/dymos
+          # Note: bugfixes sometimes require incrementing the minimal version of openmdao or dymos.
           - NAME: oldest
             PY: '3.9'
             NUMPY: '1.20'
             SCIPY: '1.6'
             PYOPTSPARSE: 'v2.9.1'
             SNOPT: '7.7'
-            OPENMDAO: '3.33.0'
+            OPENMDAO: '3.35.0'
             DYMOS: '1.8.0'
 
           # latest versions of openmdao/dymos
@@ -50,8 +51,7 @@ jobs:
             SCIPY: 1
             PYOPTSPARSE: 'v2.9.1'
             SNOPT: '7.7'
-            #OPENMDAO: 'latest'
-            OPENMDAO: '3.34.2'
+            OPENMDAO: 'latest'
             DYMOS: 'latest'
 
     steps:

.github/workflows/test_workflow_dev_deps.yml

@@ -14,7 +14,7 @@ on:
 jobs:
 
   test_ubuntu:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -27,8 +27,7 @@ jobs:
             SCIPY: 1
             PYOPTSPARSE: 'latest'
             SNOPT: '7.7'
-            #OPENMDAO: 'dev'
-            OPENMDAO: '3.34.2'
+            OPENMDAO: 'dev'
             DYMOS: 'dev'
 
     steps:

.github/workflows/test_workflow_no_dev_install.yml

@@ -17,7 +17,7 @@ on:
 jobs:
 
   test_ubuntu_no_dev_install:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     timeout-minutes: 90
 
@@ -70,7 +70,6 @@ jobs:
           echo ""
           echo "Temporarily install specific versions for now."
           pip install "numpy<2"
-          pip install "openmdao==3.34.2"
           pip install packaging
           pip install .[all]
 

.gitignore

@@ -152,5 +152,9 @@ coloring_files/
 # OpenMDAO N2 diagrams
 n2.html
 
+# Input and output lists
+input_list.txt
+output_list.txt
+
 # Windows downloads
 *:Zone.Identifier

aviary/api.py

@@ -23,7 +23,7 @@
 from aviary.variable_info.options import get_option_defaults, is_option
 from aviary.utils.develop_metadata import add_meta_data, update_meta_data
 from aviary.variable_info.variable_meta_data import CoreMetaData
-from aviary.variable_info.functions import add_aviary_input, add_aviary_output, get_units, override_aviary_vars, setup_trajectory_params
+from aviary.variable_info.functions import add_aviary_input, add_aviary_output, get_units, override_aviary_vars, setup_trajectory_params, setup_model_options
 from aviary.utils.merge_hierarchies import merge_hierarchies
 from aviary.utils.merge_variable_metadata import merge_meta_data
 from aviary.utils.named_values import NamedValues, get_keys, get_items, get_values

aviary/constants.py

@@ -7,6 +7,8 @@
 GRAV_METRIC_FLOPS = 9.80665  # m/s^2
 GRAV_ENGLISH_FLOPS = 32.17399  # ft/s^2
 GRAV_ENGLISH_LBM = 1.0  # lbf/lbm
+# TODO this does not match what dymos atmosphere comp predicts, which leads to subtle
+#      problems such as density ratio not being 1 at sea level
 RHO_SEA_LEVEL_ENGLISH = 0.0023769  # slug/ft^3
 RHO_SEA_LEVEL_METRIC = 1.225  # kg/m^3
 MU_TAKEOFF = 0.02  # TODO: fill in coefficient of friction for takeoff

aviary/docs/_toc.yml

@@ -45,6 +45,7 @@ parts:
       - file: user_guide/features/overriding
       - file: user_guide/FLOPS_based_detailed_takeoff_and_landing
       - file: user_guide/reserve_missions
+      - file: user_guide/multi_mission
       - file: user_guide/off_design_missions
       - file: user_guide/SGM_capabilities
     - file: user_guide/troubleshooting
@@ -57,6 +58,7 @@ parts:
     - file: examples/coupled_aircraft_mission_optimization
     - file: examples/additional_flight_phases
     - file: examples/reserve_missions
+    - file: examples/multi_mission
     - file: examples/off_design_example
     - file: examples/OAS_subsystem
     - file: examples/level_2_detailed_takeoff_and_landing
@@ -82,6 +84,9 @@ parts:
     - file: developer_guide/unit_tests
     - file: developer_guide/contributing_guidelines
     - file: developer_guide/how_to_contribute_docs
+      sections:
+      - file: developer_guide/doctape.ipynb
+      - file: developer_guide/doctape_examples.ipynb
     - file: developer_guide/debugging_env_from_github
 
 - caption: Miscellaneous Resources

aviary/docs/developer_guide/codebase_overview.ipynb

@@ -10,15 +10,15 @@
    },
    "outputs": [],
    "source": [
-    "from aviary.docs.tests.utils import Markdown, glue_variable\n",
+    "from aviary.utils.doctape import glue_variable\n",
     "\n",
     "structure = {\n",
     "    'docs':'contains the doc files for Aviary',\n",
     "    'examples':'contains example code for using Aviary, including external subsystem examples',\n",
     "    'interface':'is where most code that users interact with is located',\n",
     "    'mission':'contains OpenMDAO components and groups for modeling the aircraft mission',\n",
     "    'models':'contains aircraft and propulsion models for use in Aviary examples and tests',\n",
-    "    'subsystems':'is where the aerodynamic, propulsion, mass, and geometry core subsystems are located',\n",
+    "    'subsystems':'is where the aerodynamic, atmosphere, energy, propulsion, mass, and geometry core subsystems are located',\n",
     "    'utils':'contains utility functions for use in Aviary code, examples, and tests',\n",
     "    'validation_cases':'contains validation cases for testing and benchmarking Aviary',\n",
     "    'variable_info':'contains the variable meta data as well as several variable classes that are used in Aviary',\n",
@@ -31,7 +31,7 @@
     "\n",
     "# change display to False to prevent displaying the results when running cells directly\n",
     "# (Does not change the generated book)\n",
-    "glue_variable('folder_structure', Markdown(bulleted_list), display=True)\n"
+    "glue_variable('folder_structure', bulleted_list, display=True)\n"
    ]
   },
   {
@@ -62,7 +62,7 @@
     "# Testing Cell\n",
     "import os\n",
     "from aviary.utils.functions import get_path\n",
-    "from aviary.docs.tests.utils import check_contains\n",
+    "from aviary.utils.doctape import check_contains\n",
     "\n",
     "folder  = get_path('docs').parent\n",
     "subfolders = [ f.name for f in os.scandir(folder) ]\n",

aviary/docs/developer_guide/coding_standards.ipynb

@@ -12,15 +12,15 @@
    "source": [
     "# Testing Cell\n",
     "import aviary.api as av\n",
-    "from aviary.docs.tests.utils import get_attribute_name, glue_variable\n",
+    "from aviary.utils.doctape import get_attribute_name, get_variable_name, glue_variable\n",
     "Verbosity = av.Verbosity;\n",
     "\n",
     "verbosity = get_attribute_name(av.Settings,av.Settings.VERBOSITY)\n",
     "glue_variable('VERBOSITY',verbosity, md_code=True)\n",
-    "glue_variable(f'{Verbosity=}'.split('=')[0], md_code=True)\n",
+    "glue_variable(get_variable_name(Verbosity), md_code=True)\n",
     "glue_variable('QUIET',av.Verbosity.QUIET.name, md_code=True)\n",
     "glue_variable('BRIEF',av.Verbosity.BRIEF.name, md_code=True)\n",
-    "glue_variable(f'{Verbosity.BRIEF=}'.split('=')[0], md_code=True)\n",
+    "glue_variable(get_variable_name(Verbosity.BRIEF), md_code=True)\n",
     "glue_variable('VERBOSE',av.Verbosity.VERBOSE.name, md_code=True)\n",
     "glue_variable('DEBUG',av.Verbosity.DEBUG.name, md_code=True)"
    ]