Merge branch 'master' of https://github.com/OpenMDAO/dymos into newsh…

…ape_deprecation
OpenMDAO · Aug 15, 2024 · 5ad6bc6 · 5ad6bc6
2 parents 10c006f + de55c1e
commit 5ad6bc6
Show file tree

Hide file tree

Showing 12 changed files with 169 additions and 141 deletions.
diff --git a/.github/workflows/dymos_docs_workflow.yml b/.github/workflows/dymos_docs_workflow.yml
@@ -240,7 +240,6 @@ jobs:
           cd docs
           export PYDEVD_DISABLE_FILE_VALIDATION=1
           jupyter-book build -W --keep-going dymos_book
-          python copy_build_artifacts.py
 
       - name: Display doc build reports
         continue-on-error: True

diff --git a/docs/build_jupyter_book.py b/docs/build_jupyter_book.py
@@ -4,8 +4,6 @@
 import subprocess
 import pathlib
 
-from copy_build_artifacts import copy_build_artifacts
-
 
 _this_file = pathlib.Path(__file__).resolve()
 REPO_ROOT = _this_file.parent
@@ -28,7 +26,6 @@ def build_book(book_dir=BOOK_DIR, clean=True, ignore_warnings=False):
         subprocess.run(['jupyter-book', 'build', '--keep-going', book_dir])  # nosec: trusted input
     else:
         subprocess.run(['jupyter-book', 'build', '-W', '--keep-going', book_dir])  # nosec: trusted input
-    copy_build_artifacts(book_dir)
     os.chdir(save_cwd)
 
 

diff --git a/docs/build_source_docs.py b/docs/build_source_docs.py
@@ -120,7 +120,7 @@ def build_src_docs(top, src_dir, project_name='dymos'):
             # specifically don't use os.path.join here.  Even windows wants the
             # stuff in the file to have fwd slashes.
             title = f"[{package}]"
-            link = f"(packages/{package}.md)\n"
+            link = f"(packages/{package}.ipynb)\n"
             index_data += f"- {title}{link}"
 
             # make subpkg directory (e.g. _srcdocs/packages/core) for ref sheets
@@ -139,7 +139,7 @@ def build_src_docs(top, src_dir, project_name='dymos'):
                     # specifically don't use os.path.join here.  Even windows wants the
                     # stuff in the file to have fwd slashes.
                     title = f"[{sub_package}]"
-                    link = f"({package}/{sub_package}.md)\n"
+                    link = f"({package}/{sub_package}.ipynb)\n"
                     package_data += f"- {title}{link}"
 
                     # creates and writes out one reference sheet (e.g. core/component.ipynb)

diff --git a/docs/copy_build_artifacts.py b/docs/copy_build_artifacts.py
diff --git a/docs/dymos_book/examples/brachistochrone/brachistochrone_tandem_phases.ipynb b/docs/dymos_book/examples/brachistochrone/brachistochrone_tandem_phases.ipynb
@@ -77,19 +77,19 @@
    ]
   },
   {
-    "cell_type": "code",
-    "execution_count": null,
-    "metadata": {
-     "tags": [
-      "active-ipynb",
-      "remove-input",
-      "remove-output"
-     ]
-    },
-    "outputs": [],
-    "source": [
-     "%matplotlib inline"
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "active-ipynb",
+     "remove-input",
+     "remove-output"
     ]
+   },
+   "outputs": [],
+   "source": [
+    "%matplotlib inline"
+   ]
   },
   {
    "cell_type": "code",
@@ -307,6 +307,8 @@
    },
    "outputs": [],
    "source": [
+    "import pathlib\n",
+    "\n",
     "from bokeh.plotting import figure, show, output_notebook, output_file, save\n",
     "\n",
     "from bokeh.palettes import d3\n",
@@ -345,12 +347,30 @@
     "p1.xaxis.axis_label = 'time (s)'\n",
     "p1.yaxis.axis_label = 'state value'\n",
     "p1.legend.location = 'bottom_right'\n",
-    "     \n",
+    "\n",
     "output_file('plot.html', mode='inline')\n",
     "plot_file = save(p1)\n",
     "\n",
-    "HTML(filename=plot_file)"
+    "# Define the path to the HTML file\n",
+    "html_file_path = pathlib.Path('plot.html')\n",
+    "html_content = html_file_path.read_text()\n",
+    "\n",
+    "# Inject CSS to control the output cell height and avoid scrollbars\n",
+    "html_with_custom_height = f\"\"\"\n",
+    "<div style=\"height: 320px; overflow: auto;\">\n",
+    "    {html_content}\n",
+    "</div>\n",
+    "\"\"\"\n",
+    "\n",
+    "HTML(html_with_custom_height)"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -370,7 +390,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/docs/dymos_book/examples/bryson_denham/bryson_denham.ipynb b/docs/dymos_book/examples/bryson_denham/bryson_denham.ipynb
@@ -457,8 +457,7 @@
    "execution_count": null,
    "id": "beea4c6a",
    "metadata": {
-    "id": "beea4c6a",
-    "scrolled": true
+    "id": "beea4c6a"
    },
    "outputs": [],
    "source": [
@@ -555,13 +554,14 @@
     },
     "id": "da31be29",
     "outputId": "f351fca0-6415-4469-8a42-dc035fe2bbc4",
-    "scrolled": false,
     "tags": [
      "hide-input"
     ]
    },
    "outputs": [],
    "source": [
+    "import pathlib\n",
+    "\n",
     "import matplotlib as mpl\n",
     "from matplotlib import animation\n",
     "\n",
@@ -681,7 +681,18 @@
     "from IPython.display import HTML\n",
     "with open('anim.html', 'w') as f:\n",
     "    f.write(anim.to_jshtml())\n",
-    "HTML('anim.html')"
+    "\n",
+    "# Define the path to the HTML file\n",
+    "html_content = pathlib.Path('anim.html').read_text()\n",
+    "\n",
+    "# Inject CSS to control the output cell height and avoid scrollbars\n",
+    "html_with_custom_height = f\"\"\"\n",
+    "<div style=\"height: 400px; overflow: auto;\">\n",
+    "    {html_content}\n",
+    "</div>\n",
+    "\"\"\"\n",
+    "\n",
+    "HTML(html_with_custom_height)"
    ]
   },
   {
@@ -719,7 +730,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/docs/dymos_book/examples/cannonball_implicit_duration/cannonball_implicit_duration.ipynb b/docs/dymos_book/examples/cannonball_implicit_duration/cannonball_implicit_duration.ipynb
@@ -74,19 +74,19 @@
    ]
   },
   {
-    "cell_type": "code",
-    "execution_count": null,
-    "metadata": {
-     "tags": [
-      "active-ipynb",
-      "remove-input",
-      "remove-output"
-     ]
-    },
-    "outputs": [],
-    "source": [
-     "%matplotlib inline"
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "active-ipynb",
+     "remove-input",
+     "remove-output"
     ]
+   },
+   "outputs": [],
+   "source": [
+    "%matplotlib inline"
+   ]
   },
   {
    "cell_type": "code",
@@ -387,7 +387,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Plotting the results"
+    "## Displaying the timeseries data"
    ]
   },
   {
@@ -398,9 +398,20 @@
    },
    "outputs": [],
    "source": [
-    "from IPython.display import IFrame\n",
+    "from IPython.display import HTML\n",
+    "\n",
+    "# Define the path to the HTML file\n",
+    "html_file_path = p.get_reports_dir() / 'traj_results_report.html'\n",
+    "html_content = html_file_path.read_text()\n",
+    "\n",
+    "# Inject CSS to control the output cell height and avoid scrollbars\n",
+    "html_with_custom_height = f\"\"\"\n",
+    "<div style=\"height: 800px; overflow: auto;\">\n",
+    "    {html_content}\n",
+    "</div>\n",
+    "\"\"\"\n",
     "\n",
-    "IFrame(src='reports/cannonball_implicit_duration/traj_results_report.html', width=700, height=1000)"
+    "HTML(html_with_custom_height)"
    ]
   },
   {

diff --git a/docs/dymos_book/examples/commercial_aircraft/commercial_aircraft.ipynb b/docs/dymos_book/examples/commercial_aircraft/commercial_aircraft.ipynb
@@ -523,19 +523,19 @@
    ]
   },
   {
-    "cell_type": "code",
-    "execution_count": null,
-    "metadata": {
-     "tags": [
-      "active-ipynb",
-      "remove-input",
-      "remove-output"
-     ]
-    },
-    "outputs": [],
-    "source": [
-     "%matplotlib inline"
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "active-ipynb",
+     "remove-input",
+     "remove-output"
     ]
+   },
+   "outputs": [],
+   "source": [
+    "%matplotlib inline"
+   ]
   },
   {
    "cell_type": "code",
@@ -674,8 +674,19 @@
    },
    "outputs": [],
    "source": [
-    "from IPython.display import IFrame\n",
-    "IFrame(src=str(p.get_reports_dir() / 'traj_results_report.html'), width=800, height=1200)"
+    "from IPython.display import HTML\n",
+    "# Define the path to the HTML file\n",
+    "html_file_path = p.get_reports_dir() / 'traj_results_report.html'\n",
+    "html_content = html_file_path.read_text()\n",
+    "\n",
+    "# Inject CSS to control the output cell height and avoid scrollbars\n",
+    "html_with_custom_height = f\"\"\"\n",
+    "<div style=\"height: 800px; overflow: auto;\">\n",
+    "    {html_content}\n",
+    "</div>\n",
+    "\"\"\"\n",
+    "\n",
+    "HTML(html_with_custom_height)\n"
    ]
   },
   {
@@ -734,7 +745,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/docs/dymos_book/examples/moon_landing/moon_landing.ipynb b/docs/dymos_book/examples/moon_landing/moon_landing.ipynb
@@ -235,8 +235,20 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from IPython.display import IFrame\n",
-    "IFrame(src=str(p.get_reports_dir() / 'traj_results_report.html'), width=800, height=1200)"
+    "from IPython.display import HTML\n",
+    "\n",
+    "# Define the path to the HTML file\n",
+    "html_file_path = p.get_reports_dir() / 'traj_results_report.html'\n",
+    "html_content = html_file_path.read_text()\n",
+    "\n",
+    "# Inject CSS to control the output cell height and avoid scrollbars\n",
+    "html_with_custom_height = f\"\"\"\n",
+    "<div style=\"height: 800px; overflow: auto;\">\n",
+    "    {html_content}\n",
+    "</div>\n",
+    "\"\"\"\n",
+    "\n",
+    "HTML(html_with_custom_height)"
    ]
   },
   {

diff --git a/docs/dymos_book/examples/mountain_car/mountain_car.ipynb b/docs/dymos_book/examples/mountain_car/mountain_car.ipynb
@@ -212,19 +212,19 @@
    ]
   },
   {
-    "cell_type": "code",
-    "execution_count": null,
-    "metadata": {
-     "tags": [
-      "active-ipynb",
-      "remove-input",
-      "remove-output"
-     ]
-    },
-    "outputs": [],
-    "source": [
-     "%matplotlib inline"
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "active-ipynb",
+     "remove-input",
+     "remove-output"
     ]
+   },
+   "outputs": [],
+   "source": [
+    "%matplotlib inline"
+   ]
   },
   {
    "cell_type": "code",