Glue Variables in User_Guide

aviary/docs/developer_guide/doctape.ipynb

@@ -71,6 +71,8 @@
     "    \"get_attribute_name\": \"gets the name of an object's attribute based on it's value\",\n",
     "    \"get_all_keys\": \"recursively get all of the keys from a dict of dicts\",\n",
     "    \"get_value\": \"recursively get a value from a dict of dicts\",\n",
+    "    \"get_class_names\": \"gets all class names from a given file and return as a set\",\n",
+    "    \"get_function_names\": \"gets all function names in a given file and return as a set\",\n",
     "}\n",
     "\n",
     "doctape.check_value(imported_classes.keys(),custom_classes.keys())\n",

aviary/docs/developer_guide/how_to_contribute_docs.md

@@ -3,7 +3,9 @@
 Doc pages can be added as `.ipynb` or `.md` files within the `aviary/docs` folder.
 We're using [jupyter-book](https://jupyterbook.org/) for the docs, which is a well-documented and full-featured platform.
 To build the docs, you'll need to install jupyter-book following [these instructions](https://jupyterbook.org/en/stable/start/overview.html).
-Jupyter-book allows for arbitrary Jupyter notebook usage to intersperse code and documentation and it uses [MyST markdown](https://jupyterbook.org/en/stable/content/myst.html).
+Jupyter-book allows for arbitrary Jupyter notebook usage to intersperse code and documentation and it uses [MyST markdown](https://jupyterbook.org/en/stable/content/myst.html). 
+
+Whenever a page contains code, it should be a Jupyter notebook. Otherwise, you can write it as markdown page. Note that if you run an optimiser in a Jupyter notebook, don't use `SNOPT` because it is not available in test run on Github. Also, if you plan to push a Jupyter notebook to the Aviary repository, make sure you run `reset_notebook` on that page.
 
 To modify the docs, simply add a file to the repo within the docs folder.
 You can then add it to the `docs/_toc.yml` file following the structure for the skeletal outline.

aviary/docs/misc_resources/externally_supported_subsystems.ipynb

@@ -7,7 +7,7 @@
     "# Externally Supported Subsystems\n",
     "\n",
     "Aviary supports any generic subsystem that a user adds.\n",
-    "We include some examples within the Aviary repo within the `aviary/examples/external_subsystems` folder."
+    "We include some examples within the Aviary repo within the {glue:md}`aviary/examples/external_subsystems` folder."
    ]
   },
   {
@@ -22,7 +22,9 @@
    "source": [
     "# Testing Cell\n",
     "import aviary.api as av\n",
-    "av.get_path('examples/external_subsystems')"
+    "from aviary.utils.doctape import glue_variable\n",
+    "av.get_path('examples/external_subsystems')\n",
+    "glue_variable('aviary/examples/external_subsystems', md_code=True)"
    ]
   }
  ],

aviary/docs/misc_resources/modeling_exercise.ipynb

@@ -20,8 +20,8 @@
     "\n",
     "## Task 1: Run a basic Aviary script\n",
     "\n",
-    "Aviary ships with multiple examples in the `aviary/examples` directory.\n",
-    "The most basic, `run_basic_aviary_example.py`, [(available here)](https://github.com/OpenMDAO/Aviary/blob/main/aviary/examples/run_basic_aviary_example.py) is our first starting point.\n",
+    "Aviary ships with multiple examples in the {glue:md}`aviary/examples` directory.\n",
+    "The most basic, {glue:md}`run_basic_aviary_example.py`, [(available here)](https://github.com/OpenMDAO/Aviary/blob/main/aviary/examples/run_basic_aviary_example.py) is our first starting point.\n",
     "Run this script in your terminal."
    ]
   },
@@ -37,7 +37,10 @@
    "source": [
     "# Testing Cell\n",
     "import aviary.api as av\n",
-    "av.get_path('examples/run_basic_aviary_example.py')"
+    "from aviary.utils.doctape import glue_variable\n",
+    "av.get_path('examples/run_basic_aviary_example.py')\n",
+    "glue_variable('aviary/examples', md_code=True)\n",
+    "glue_variable('run_basic_aviary_example.py', md_code=True)"
    ]
   },
   {
@@ -76,6 +79,27 @@
     "_command_map['dashboard'];"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "remove-cell"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "# Testing Cell\n",
+    "from aviary.interface.methods_for_level2 import AviaryGroup\n",
+    "from aviary.utils.doctape import glue_variable\n",
+    "\n",
+    "ag = AviaryGroup()\n",
+    "opts = list(ag.options)\n",
+    "for opt in opts:\n",
+    "    if opt == 'phase_info':\n",
+    "        glue_variable('phase_info', md_code=True)\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -88,10 +112,10 @@
     "The next step is to run an Aviary case with a mission profile that you define.\n",
     "Please follow the [instructions in this example doc](../examples/simple_mission_example) to create a custom mission profile.\n",
     "Once you have created your custom mission profile, run the Aviary case following the instructions in the example doc.\n",
-    "If you are not able to successfully create a custom `phase_info` object to define the mission, please use the default one defined in the example.\n",
+    "If you are not able to successfully create a custom {glue:md}`phase_info` object to define the mission, please use the default one defined in the example.\n",
     "\n",
     "```{note}\n",
-    "The survey will ask you to provide a copy of the `phase_info` object you create, so please save this information for later.\n",
+    "The survey will ask you to provide a copy of the {glue:md}`phase_info` object you create, so please save this information for later.\n",
     "```\n",
     "\n",
     "Again open the Aviary dashboard and visually examine the results by running the following command in your terminal:\n",
@@ -103,7 +127,7 @@
     "## Task 3: Run a mission with a reserve phase\n",
     "\n",
     "Aviary has the capability to run a mission with a reserve phase as [detailed in the docs here](https://openmdao.github.io/Aviary/examples/reserve_missions.html).\n",
-    "The included example, `run_reserve_mission_fixedrange.py`, [(available here)](https://github.com/OpenMDAO/Aviary/blob/main/aviary/examples/reserve_missions/run_reserve_mission_fixedrange.py) demonstrates how to run a mission with a reserve phase.\n",
+    "The included example, {glue:md}`run_reserve_mission_fixedrange.py`, [(available here)](https://github.com/OpenMDAO/Aviary/blob/main/aviary/examples/reserve_missions/run_reserve_mission_fixedrange.py) demonstrates how to run a mission with a reserve phase.\n",
     "Please copy the contents of this file into a new Python script."
    ]
   },
@@ -119,7 +143,9 @@
    "source": [
     "# Testing Cell\n",
     "import aviary.api as av\n",
-    "av.get_path('examples/reserve_missions/run_reserve_mission_fixedrange.py');"
+    "from aviary.utils.doctape import glue_variable\n",
+    "av.get_path('examples/reserve_missions/run_reserve_mission_fixedrange.py');\n",
+    "glue_variable('run_reserve_mission_fixedrange.py', md_code=True)"
    ]
   },
   {
@@ -141,7 +167,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "latest_env",
+   "display_name": "av1",
    "language": "python",
    "name": "python3"
   },
@@ -155,7 +181,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.13"
+   "version": "3.9.18"
   }
  },
  "nbformat": 4,