Update documentation

OpenMDAO · Aug 9, 2023 · 22d7270 · 22d7270
1 parent dfd061f
commit 22d7270
Show file tree

Hide file tree

Showing 88 changed files with 144,279 additions and 143,263 deletions.
diff --git a/...daf492154bf4916ce4a1bc6202cf0f38d3bc1.png → ...619bfd80dafdbdd3fffada38b6878fbe59c34.png b/...daf492154bf4916ce4a1bc6202cf0f38d3bc1.png → ...619bfd80dafdbdd3fffada38b6878fbe59c34.png
diff --git a/...3612e8f946f59752bc632bbaa4ec655870076.png → ...785be260346c8f922656051a8c77bdbb2fcee.png b/...3612e8f946f59752bc632bbaa4ec655870076.png → ...785be260346c8f922656051a8c77bdbb2fcee.png
diff --git a/_images/21be9567785e4284eb2ec5e2133be337adc033c0a1bb2309ccb770ddd2e0f716.png b/_images/21be9567785e4284eb2ec5e2133be337adc033c0a1bb2309ccb770ddd2e0f716.png
diff --git a/_images/33285cd3a1be5019a41c58ecfdce53547665eb9e3646241968af890f42f26543.png b/_images/33285cd3a1be5019a41c58ecfdce53547665eb9e3646241968af890f42f26543.png
diff --git a/_images/4bcfe9e1e14bd17864c5b1fdbc428db9a4047e01030e81c9f4d320bcf5285084.png b/_images/4bcfe9e1e14bd17864c5b1fdbc428db9a4047e01030e81c9f4d320bcf5285084.png
diff --git a/_images/54ec70d14a2033cdd5e0c3abfd0ae721ce11c1c3811790f06e33c5dd5340623b.png b/_images/54ec70d14a2033cdd5e0c3abfd0ae721ce11c1c3811790f06e33c5dd5340623b.png
diff --git a/_images/57e5e4fc35b0353a095af97ecc8eceaab04a37caf67e1d6313f3069e209b7b25.png b/_images/57e5e4fc35b0353a095af97ecc8eceaab04a37caf67e1d6313f3069e209b7b25.png
diff --git a/_images/5a299d019213ff7d6694b9c10f711dae316076e0c8436882829add0903624046.png b/_images/5a299d019213ff7d6694b9c10f711dae316076e0c8436882829add0903624046.png
diff --git a/...39bc00bf46e1e304504771df1d7e5198e0faf.png → ...01975ad5116aaec7b33660272914e16fb3ccb.png b/...39bc00bf46e1e304504771df1d7e5198e0faf.png → ...01975ad5116aaec7b33660272914e16fb3ccb.png
diff --git a/...76ef5376bc0367fbb11144329b3b009ec7f81.png → ...51a1dd920edaa9fdb1ccf15b3cb423ab6f463.png b/...76ef5376bc0367fbb11144329b3b009ec7f81.png → ...51a1dd920edaa9fdb1ccf15b3cb423ab6f463.png
diff --git a/_images/89c7da911debbaa380e6de4730a161d86a4cf3efeaf0730a8a2c9b9f25785e57.png b/_images/89c7da911debbaa380e6de4730a161d86a4cf3efeaf0730a8a2c9b9f25785e57.png
diff --git a/_images/97b494d19c80ea449a7ee37efdecfe6af78d977ec5c14deebff77b43f1e5e7bb.png b/_images/97b494d19c80ea449a7ee37efdecfe6af78d977ec5c14deebff77b43f1e5e7bb.png
diff --git a/_images/b9c572adafb21afa6d00a0a2aaaf4feb5a62973bef0d3400c251d9f279bc43aa.png b/_images/b9c572adafb21afa6d00a0a2aaaf4feb5a62973bef0d3400c251d9f279bc43aa.png
diff --git a/_images/c85d404f11cf640a4617242f3a91ae288181a50962ef4bb632b877e50a5c3069.png b/_images/c85d404f11cf640a4617242f3a91ae288181a50962ef4bb632b877e50a5c3069.png
diff --git a/_images/cb7711e6a8e729268bbe9d6bc748fe7dfbb668d042267c023c8d7f7b076ae58d.png b/_images/cb7711e6a8e729268bbe9d6bc748fe7dfbb668d042267c023c8d7f7b076ae58d.png
diff --git a/_images/f959abff660a5952122decf995fa0f5c44f5c8c06410b8d09aa41b5f0e08d9bd.png b/_images/f959abff660a5952122decf995fa0f5c44f5c8c06410b8d09aa41b5f0e08d9bd.png
diff --git a/_modules/dymos/phase/analytic_phase.html b/_modules/dymos/phase/analytic_phase.html
@@ -237,7 +237,8 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../api/api.html">Dymos Reference API</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../../api/run_problem_function.html">The run_problem function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../../api/phase_api.html">The Phase API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/phase_api.html">Phase Options</a></li>
+
 <li class="toctree-l2"><a class="reference internal" href="../../../api/transcriptions_api.html">The Transcriptions API</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../api/trajectory_api.html">The Trajectory API</a></li>
 </ul>

diff --git a/_modules/dymos/phase/phase.html b/_modules/dymos/phase/phase.html
@@ -237,7 +237,8 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../api/api.html">Dymos Reference API</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../../api/run_problem_function.html">The run_problem function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../../api/phase_api.html">The Phase API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/phase_api.html">Phase Options</a></li>
+
 <li class="toctree-l2"><a class="reference internal" href="../../../api/transcriptions_api.html">The Transcriptions API</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../api/trajectory_api.html">The Trajectory API</a></li>
 </ul>

diff --git a/_modules/dymos/run_problem.html b/_modules/dymos/run_problem.html
@@ -237,7 +237,8 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../api/api.html">Dymos Reference API</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../api/run_problem_function.html">The run_problem function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../api/phase_api.html">The Phase API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/phase_api.html">Phase Options</a></li>
+
 <li class="toctree-l2"><a class="reference internal" href="../../api/transcriptions_api.html">The Transcriptions API</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../api/trajectory_api.html">The Trajectory API</a></li>
 </ul>

diff --git a/_modules/dymos/trajectory/trajectory.html b/_modules/dymos/trajectory/trajectory.html
@@ -237,7 +237,8 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../api/api.html">Dymos Reference API</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../../api/run_problem_function.html">The run_problem function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../../api/phase_api.html">The Phase API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/phase_api.html">Phase Options</a></li>
+
 <li class="toctree-l2"><a class="reference internal" href="../../../api/transcriptions_api.html">The Transcriptions API</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../api/trajectory_api.html">The Trajectory API</a></li>
 </ul>

diff --git a/_modules/index.html b/_modules/index.html
@@ -237,7 +237,8 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api/api.html">Dymos Reference API</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../api/run_problem_function.html">The run_problem function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../api/phase_api.html">The Phase API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/phase_api.html">Phase Options</a></li>
+
 <li class="toctree-l2"><a class="reference internal" href="../api/transcriptions_api.html">The Transcriptions API</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../api/trajectory_api.html">The Trajectory API</a></li>
 </ul>

diff --git a/_sources/api/phase_api.ipynb b/_sources/api/phase_api.ipynb
@@ -47,14 +47,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# The Phase API"
+    "# Phase Options"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Options"
+    "## Phase.options\n",
+    "General options available to all dymos Phases."
    ]
   },
   {
@@ -67,14 +68,95 @@
    },
    "outputs": [],
    "source": [
-    "om.show_options_table('dymos.phase.Phase')"
+    "import dymos\n",
+    "phase = dymos.Phase()\n",
+    "\n",
+    "om.show_options_table(phase)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The transcription is an instance of one of the [transcriptions](./transcriptions_api) available in Dymos.\n",
+    "\n",
+    "\n",
+    "Other options listed below control the behavior of various aspects of Phases.\n",
+    "While most have corresponding phase methods for setting these values, users may now use the `set` method of OpenMDAO's OptionsDictionary to set the values of these options."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Phase.timeseries_options\n",
+    "\n",
+    "These options control the behavior of timeseries within a Phase."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true,
+    "tags": [
+     "remove-input"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "om.show_options_table(phase.timeseries_options)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Phase.refine_options\n",
+    "These options control grid refinement within each Phase."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true,
+    "tags": [
+     "remove-input"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "om.show_options_table(phase.refine_options)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Phase.simulate_options\n",
+    "These options control the behavior of phase explicit simulation."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true,
+    "tags": [
+     "remove-input"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "om.show_options_table(phase.simulate_options)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The transcription is an instance of one of the [transcriptions](./transcriptions_api) available in Dymos.\n"
+    "# Phase Methods"
    ]
   },
   {
@@ -205,7 +287,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.5"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/api/api.html b/api/api.html
@@ -240,7 +240,8 @@
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Dymos Reference API</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="run_problem_function.html">The run_problem function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="phase_api.html">The Phase API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="phase_api.html">Phase Options</a></li>
+
 <li class="toctree-l2"><a class="reference internal" href="transcriptions_api.html">The Transcriptions API</a></li>
 <li class="toctree-l2"><a class="reference internal" href="trajectory_api.html">The Trajectory API</a></li>
 </ul>