Glue Variables in User_Guide #615

xjjiang · 2024-11-28T01:54:43Z

Summary

Glue variables in user_guide and misc_resources folders.

Related Issues

Resolves #

Backwards incompatibilities

None

New Dependencies

None

…ses problem when I run. Remove a duplicate glue variable --verbosity.

…les_of_the_same_mission_at_different_UI_levels.ipynb

Replace Dynamic.Mission.MACH by Dynamic.Atmosphere.MACH.

Remove Aircraft.Engine.USE_PROPELLER_MAP.

aviary/docs/misc_resources/externally_supported_subsystems.ipynb

aviary/docs/misc_resources/modeling_exercise.ipynb

aviary/docs/user_guide/SGM_capabilities.ipynb

aviary/docs/user_guide/aerodynamics.ipynb

aviary/docs/user_guide/aviary_commands.ipynb

…phase_info'.

aviary/docs/misc_resources/modeling_exercise.ipynb

crecine · 2025-01-27T23:44:13Z

aviary/docs/user_guide/aviary_commands.ipynb

+    "command = 'dashboard'\n",
+    "parser = argparse.ArgumentParser()\n",
+    "_command_map[command][0](parser)\n",
+    "actions = [*parser._get_optional_actions(),*parser._get_positional_actions()]\n",
+    "for action in actions:\n",
+    "    opt_list = action.option_strings\n",
+    "    for opt in opt_list:\n",
+    "        if opt not in current_opt_vars:\n",
+    "            glue_variable(opt, md_code=True)\n",
+    "            current_opt_vars.append(opt)\n",
+    "    if action.dest not in current_opt_vars:\n",
+    "        glue_variable(action.dest, md_code=True)\n",
+    "        current_opt_vars.append(action.dest)\n"


since you are doing this so many times, this might be worth turning into a function, probably in doctape

I created a function glue_actions() but leave it locally. Otherwise, I would have to import _command_map into utils/doctape.py.

importing _command_map in doctape should be fine

aviary/docs/user_guide/postprocessing_and_visualizing_results.ipynb

aviary/docs/user_guide/reserve_missions.ipynb

aviary/docs/user_guide/step_by_step_external_guide.ipynb

aviary/docs/user_guide/variable_hierarchy.ipynb

aviary/docs/user_guide/variable_metadata.ipynb

…y Carl.

crecine · 2025-01-31T21:17:50Z

aviary/docs/misc_resources/modeling_exercise.ipynb

+    "import os\n",
    "import aviary.api as av\n",
-    "av.get_path('examples/run_basic_aviary_example.py')"
+    "from aviary.utils.doctape import glue_variable\n",
+    "\n",
+    "folder = av.get_path('examples')\n",
+    "examples_dir = folder.relative_to(av.top_dir.parent)\n",
+    "glue_variable(str(examples_dir), md_code=True)\n",
+    "\n",
+    "folder = av.get_path('examples/run_basic_aviary_example.py')\n",
+    "run_example_dir = os.path.basename(folder)\n",
+    "glue_variable(run_example_dir, md_code=True)"


Suggested change

"import os\n",

"import aviary.api as av\n",

"av.get_path('examples/run_basic_aviary_example.py')"

"from aviary.utils.doctape import glue_variable\n",

"\n",

"folder = av.get_path('examples')\n",

"examples_dir = folder.relative_to(av.top_dir.parent)\n",

"glue_variable(str(examples_dir), md_code=True)\n",

"\n",

"folder = av.get_path('examples/run_basic_aviary_example.py')\n",

"run_example_dir = os.path.basename(folder)\n",

"glue_variable(run_example_dir, md_code=True)"

"import aviary.api as av\n",

"from aviary.utils.doctape import glue_variable\n",

"\n",

"examples_dir = av.get_path('examples').relative_to(av.top_dir.parent)\n",

"glue_variable(str(examples_dir), md_code=True)\n",

"\n",

"basic_example_filepath= av.get_path('examples/run_basic_aviary_example.py')\n",

"glue_variable(basic_example_filepath.name, md_code=True)"

crecine · 2025-01-31T21:21:29Z

aviary/docs/user_guide/aviary_commands.ipynb

+    "import os\n",
    "import subprocess\n",
-    "command = 'aviary run_mission models/small_single_aisle/small_single_aisle_GASP.csv'\n",
+    "import aviary.api as av\n",
+    "from aviary.utils.doctape import glue_variable\n",
+    "\n",
+    "str_folder = 'models/small_single_aisle'\n",
+    "folder = av.get_path(str_folder)\n",
+    "model_dir = folder.relative_to(av.top_dir.parent)\n",
+    "glue_variable(str(model_dir), md_code=True)\n",
+    "\n",
+    "str_model = 'small_single_aisle_GASP.csv'\n",
+    "folder = av.get_path(str_folder) / (str_model)\n",
+    "file_name = os.path.basename(folder)\n",
+    "glue_variable(file_name, md_code=False)\n",


for anything returned by av.get_path (eg folder = av.get_path('examples/run_basic_aviary_example.py')), you can use the name attribute to get the filename, instead of importing os and using os.path.basename (os.path.basename(folder) and folder.name will both return 'run_basic_aviary_example.py', but you don't need the additional import)

crecine · 2025-01-31T21:22:22Z

aviary/docs/user_guide/aviary_commands.ipynb

+    "def glue_actions(cmd: str, curr_opts: list=[], display=True) -> list:\n",
+    "    parser = argparse.ArgumentParser()\n",
+    "    _command_map[cmd][0](parser)\n",
+    "    actions = [*parser._get_optional_actions(),*parser._get_positional_actions()]\n",
+    "    for action in actions: \n",
+    "        opt_list = action.option_strings\n",
+    "        for opt in opt_list:\n",
+    "            if opt not in curr_opts:\n",
+    "                glue_variable(opt, md_code=display)\n",
+    "                curr_opts.append(opt)\n",
+    "        if action.dest not in curr_opts:\n",
+    "            glue_variable(action.dest, md_code=display)\n",
+    "            curr_opts.append(action.dest)\n",
+    "\n",


I think this should be part of doctape, instead of just local. I can help with that, if you'd like

crecine · 2025-01-31T21:23:51Z

aviary/docs/user_guide/aviary_commands.ipynb

+    "{glue:md}`input_deck` is the path to vehicle input deck .csv file.\n",
+    "{glue:md}`--optimizer` is the name of the optimizer. The default is `SNOPT`.\n",
+    "{glue:md}`--shooting` indicates that the integration method is shooting method instead of collocation scheme. The default is collocation.\n",
+    "{glue:md}`--phase_info` is the path to phase info file. If it is missing, it depends on the integration method (collocation or shooting) and on the mission method (`settings:equations_of_motion` with value of `2DOF` or `height_energy`) which is defined in the .csv input file.\n",


settings:equations_of_motion, 2DOF, and height_energy should be glued, in case they change

crecine · 2025-01-31T21:24:33Z

aviary/docs/user_guide/aviary_commands.ipynb

@@ -296,7 +377,7 @@
    "\n",
    "If the output file exists, it will be overwritten.\n",
    "\n",
-    "The engine format is specified by `-f` or `--data_format` with one of `FLOPS`, `GASP`, and `GASP_TS` string. If multiple are specified, the last one will be used.\n",
+    "The engine format is specified by {glue:md}`-f` or {glue:md}`--data_format` with one of `FLOPS`, `GASP`, and `GASP_TS` string (`TS` stands for turbo shaft). If multiple are specified, the last one will be used.\n",


Suggested change

"The engine format is specified by {glue:md}`-f` or {glue:md}`--data_format` with one of `FLOPS`, `GASP`, and `GASP_TS` string (`TS` stands for turbo shaft). If multiple are specified, the last one will be used.\n",

"The engine format is specified by {glue:md}`-f` or {glue:md}`--data_format` with one of `FLOPS`, `GASP`, and `GASP_TS` string (`TS` stands for turboshaft). If multiple are specified, the last one will be used.\n",

crecine · 2025-01-31T21:38:43Z

aviary/docs/user_guide/hamilton_standard.ipynb

+    "glue_variable(OutMachType.HELICAL_MACH.name.title(), md_code=True)\n",
+    "glue_variable(OutMachType.MACH.name.title(), md_code=True)\n",


instead of converting these to title case, the documentation below should be corrected to match the actual values

Suggested change

"glue_variable(OutMachType.HELICAL_MACH.name.title(), md_code=True)\n",

"glue_variable(OutMachType.MACH.name.title(), md_code=True)\n",

"glue_variable(OutMachType.HELICAL_MACH.value, md_code=True)\n",

"glue_variable(OutMachType.MACH.value, md_code=True)\n",

crecine · 2025-01-31T21:39:05Z

aviary/docs/user_guide/hamilton_standard.ipynb

  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Propeller Map Alternative\n",
    "\n",
-    "The Hamilton Standard model has limitations where it can be applied; for model aircraft design, it is possible that users may want to provide their own data tables. Two sample data sets are provided in `models/propellers` folder: `general_aviation.prop` and `PropFan.prop`. In both cases, they are in `.csv` format and are converted from `GASP` maps: `general_aviation.map` and `PropFan.map` (see [Command Line Tools](aviary_commands.ipynb) for details). The difference between these two samples is that the generatl aviation sample uses helical Mach numbers as input while the propfan sample uses the free stream Mach numbers. Helical Mach numbers appear higher, due to the inclusion of the rotational component of the tip velocity. In our example, they range from 0.7 to 0.95. To determine which mach type in a GASP map is used, please look at the first integer of the first line. If it is 1, it uses helical mach; if it is 2, it uses free stream mach. To determin which mach type is an Aviary propeller file is used, please look at the second item in the header. It is either `Helical_Mach` or `Mach`.\n",
+    "The Hamilton Standard model has limitations where it can be applied; for model aircraft design, it is possible that users may want to provide their own data tables. Two sample data sets are provided in {glue:md}`models/engines/propellers` folder: {glue:md}`general_aviation.prop` and {glue:md}`PropFan.prop`. In both cases, they are in `.csv` format and are converted from `GASP` maps: {glue:md}`general_aviation.map` and {glue:md}`PropFan.map` (see [Command Line Tools](aviary_commands.ipynb) for details). The difference between these two samples is that the generatl aviation sample uses helical Mach numbers as input while the propfan sample uses the free stream Mach numbers. Helical Mach numbers appear higher, due to the inclusion of the rotational component of the tip velocity. In our example, they range from 0.7 to 0.95. To determine which mach type in a GASP map is used, please look at the first integer of the first line. If it is 1, it uses helical mach; if it is 2, it uses free stream mach. To determin which mach type is an Aviary propeller file is used, please look at the second column in the header. It is either {glue:md}`Helical_Mach` or {glue:md}`Mach`.\n",


Suggested change

"The Hamilton Standard model has limitations where it can be applied; for model aircraft design, it is possible that users may want to provide their own data tables. Two sample data sets are provided in {glue:md}`models/engines/propellers` folder: {glue:md}`general_aviation.prop` and {glue:md}`PropFan.prop`. In both cases, they are in `.csv` format and are converted from `GASP` maps: {glue:md}`general_aviation.map` and {glue:md}`PropFan.map` (see [Command Line Tools](aviary_commands.ipynb) for details). The difference between these two samples is that the generatl aviation sample uses helical Mach numbers as input while the propfan sample uses the free stream Mach numbers. Helical Mach numbers appear higher, due to the inclusion of the rotational component of the tip velocity. In our example, they range from 0.7 to 0.95. To determine which mach type in a GASP map is used, please look at the first integer of the first line. If it is 1, it uses helical mach; if it is 2, it uses free stream mach. To determin which mach type is an Aviary propeller file is used, please look at the second column in the header. It is either {glue:md}`Helical_Mach` or {glue:md}`Mach`.\n",

"The Hamilton Standard model has limitations where it can be applied; for model aircraft design, it is possible that users may want to provide their own data tables. Two sample data sets are provided in {glue:md}`models/engines/propellers` folder: {glue:md}`general_aviation.prop` and {glue:md}`PropFan.prop`. In both cases, they are in `.csv` format and are converted from `GASP` maps: {glue:md}`general_aviation.map` and {glue:md}`PropFan.map` (see [Command Line Tools](aviary_commands.ipynb) for details). The difference between these two samples is that the generatl aviation sample uses helical Mach numbers as input while the propfan sample uses the free stream Mach numbers. Helical Mach numbers appear higher, due to the inclusion of the rotational component of the tip velocity. In our example, they range from 0.7 to 0.95. To determine which mach type in a GASP map is used, please look at the first integer of the first line. If it is 1, it uses helical mach; if it is 2, it uses free stream mach. To determin which mach type is an Aviary propeller file is used, please look at the second column in the header. It is either {glue:md}`helical_mach` or {glue:md}`mach`.\n",

crecine · 2025-01-31T21:41:53Z

aviary/docs/user_guide/off_design_missions.ipynb

+    "fallout_snippet = '```\\n'\n",
+    "fallout_snippet += str_problem_type + ',' + str_fallout\n",
+    "fallout_snippet +='\\n```'\n",


the same thing could be done here as well

crecine · 2025-01-31T21:43:12Z

aviary/docs/user_guide/postprocessing_and_visualizing_results.ipynb

+    "glue_variable(run_example_dir, md_code=True)\n",
+    "\n",
+    "# Get all functions of class AviaryProblem\n",
+    "functs = inspect.getmembers(AviaryProblem, predicate=inspect.isfunction)\n",


this would be useful here as well
https://github.com/OpenMDAO/Aviary/pull/615/files#r1932616258

crecine · 2025-01-31T21:44:18Z

aviary/docs/user_guide/postprocessing_and_visualizing_results.ipynb

+    "parser = argparse.ArgumentParser()\n",
+    "_dashboard_setup_parser(parser)\n",
+    "glueing_arguments = ['problem_recorder', 'driver_recorder', 'save', 'force']\n",
+    "for action in parser._actions:\n",


here's another place glue_actions could be used

glue variables in off_design_missions.ipynb

7374d1a

xjjiang marked this pull request as draft November 28, 2024 01:54

xjjiang and others added 28 commits November 27, 2024 18:12

update how_to_contribute_docs.md

a57e8c2

update how_to_contribute_docs.md

202d3e4

glue variables in docs/user_guide/mass.ipynb

361523f

add glue in aerodynamics.ipynb

d56e7af

add glue in aviary_commands.ipynb

5aead60

minor update

2f081f7

update docstring

a8f9c8b

format aviary command options source code

cabf87a

add glue to aviary_commands.ipynb

61c2389

Merge branch 'OpenMDAO:main' into glue_user_guide

ff462c0

Merge branch 'OpenMDAO:main' into glue_user_guide

9073067

format _setup_level1_parser in methods_for_level1.py

2d16a94

autopep8

ecc22dc

minor

1829237

Merge branch 'OpenMDAO:main' into glue_user_guide

610e082

Merge branch 'OpenMDAO:main' into glue_user_guide

ff90a0a

Merge branch 'OpenMDAO:main' into glue_user_guide

b13d7ba

move aviary hangar to the end of aviary_commands.ipynb because it cau…

4167a08

…ses problem when I run. Remove a duplicate glue variable --verbosity.

glue variables in battery_subsystem_example.ipynb

968a62d

glue variables in drawing_and_running_simple_missions.ipynb

1c37f92

glue variables in drawing_and_running_simple_missions.ipynb and examp…

439a61d

…les_of_the_same_mission_at_different_UI_levels.ipynb

glue variables in external_aero.ipynb

e291aa2

add glue variables to features_and_functionalities.ipynb

af117c7

minor update

028f229

glue variables in FLOPS_based_detailed_takeoff_and_landing.ipynb

f794777

glue variables in hamilton_standard.ipynb

e779ba0

glue variables in input_files.ipynb

01cf911

glue variables in postprocessing_and_visualizing_results.ipynb

0e93159

xjjiang added 2 commits December 18, 2024 10:30

Update hamilton_standard.ipynb

a029c94

Replace Dynamic.Mission.MACH by Dynamic.Atmosphere.MACH.

Update hamilton_standard.ipynb

37a44a7

Remove Aircraft.Engine.USE_PROPELLER_MAP.

xjjiang marked this pull request as ready for review December 18, 2024 19:20

xjjiang requested a review from crecine December 18, 2024 19:21

xjjiang requested a review from jkirk5 December 31, 2024 19:17

xjjiang and others added 4 commits December 31, 2024 12:21

Merge branch 'OpenMDAO:main' into glue_user_guide

9a4dd57

Merge branch 'main' into glue_user_guide

c6448c5

Merge branch 'OpenMDAO:main' into glue_user_guide

a1dba9b

very minor update

1b4e910

crecine reviewed Jan 13, 2025

View reviewed changes

crecine mentioned this pull request Jan 13, 2025

Glue getting started and theory guide #609

Open

xjjiang and others added 8 commits January 13, 2025 22:10

Merge branch 'OpenMDAO:main' into glue_user_guide

95ab9ab

accept Carl's suggestions: modify the glue of paths and the glue of '…

4bbce12

…phase_info'.

modify the usage of Argparser as suggested by Carl.

8c20e6e

make changes based on Carl's comments.

126eca1

Merge branch 'OpenMDAO:main' into glue_user_guide

5555157

Merge branch 'OpenMDAO:main' into glue_user_guide

018056d

Merge branch 'main' into glue_user_guide

8a384b0

Merge branch 'OpenMDAO:main' into glue_user_guide

d95fefa

crecine reviewed Jan 28, 2025

View reviewed changes

xjjiang and others added 9 commits January 29, 2025 09:05

Merge branch 'OpenMDAO:main' into glue_user_guide

355aea4

added top_dir as Carl did.

c3cd8d6

Merge branch 'OpenMDAO:main' into glue_user_guide

70f62f6

Merge branch 'main' into glue_user_guide

94c532d

fixed a few bugs due to changes in main. Modified top_dir suggested b…

710135f

…y Carl.

Merge branch 'main' into glue_user_guide

a0f3c9c

Merge branch 'OpenMDAO:main' into glue_user_guide

8392e0f

update based on Carl's comments.

737ff87

created function glue_actions locally

991b4e4

crecine reviewed Jan 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Glue Variables in User_Guide #615

Glue Variables in User_Guide #615

xjjiang commented Nov 28, 2024 •

edited

Loading

crecine Jan 27, 2025

xjjiang Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

crecine Jan 31, 2025

	"The engine format is specified by {glue:md}`-f` or {glue:md}`--data_format` with one of `FLOPS`, `GASP`, and `GASP_TS` string (`TS` stands for turbo shaft). If multiple are specified, the last one will be used.\n",
	"The engine format is specified by {glue:md}`-f` or {glue:md}`--data_format` with one of `FLOPS`, `GASP`, and `GASP_TS` string (`TS` stands for turboshaft). If multiple are specified, the last one will be used.\n",

		"glue_variable(OutMachType.HELICAL_MACH.name.title(), md_code=True)\n",
		"glue_variable(OutMachType.MACH.name.title(), md_code=True)\n",

Glue Variables in User_Guide #615

Are you sure you want to change the base?

Glue Variables in User_Guide #615

Conversation

xjjiang commented Nov 28, 2024 • edited Loading

Summary

Related Issues

Backwards incompatibilities

New Dependencies

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xjjiang commented Nov 28, 2024 •

edited

Loading