update docs

nasa · Sep 30, 2023 · 851b0b9 · 851b0b9
1 parent 207a8a4
commit 851b0b9
Show file tree

Hide file tree

Showing 44 changed files with 655 additions and 2,055 deletions.
diff --git a/CONTRIBUTORS.html b/CONTRIBUTORS.html
@@ -197,6 +197,12 @@
 <li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Demonstration.html#Hierarchical-Model">Hierarchical Model</a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html">Urban Drone Demo</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html#Model-Overview">Model Overview</a></li>
+<li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html#Nominal-Simulation">Nominal Simulation</a></li>
+<li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html#Resilience-model">Resilience model</a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="examples/multirotor/Multirotor_Optimization.html">Integrated Resilience Optimization Architectures</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Multirotor_Optimization.html#Design-Model">Design Model</a></li>
 <li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Multirotor_Optimization.html#Operational-Model">Operational Model</a></li>
@@ -358,7 +364,6 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.state">fmdtools.define.state</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.state.ExamplePoint"><code class="docutils literal notranslate"><span class="pre">ExamplePoint</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.state.State"><code class="docutils literal notranslate"><span class="pre">State</span></code></a></li>
 </ul>
 </li>
@@ -368,14 +373,6 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.geom">fmdtools.define.geom</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExGeomArch"><code class="docutils literal notranslate"><span class="pre">ExGeomArch</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExGeomState"><code class="docutils literal notranslate"><span class="pre">ExGeomState</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExLine"><code class="docutils literal notranslate"><span class="pre">ExLine</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExLineParam"><code class="docutils literal notranslate"><span class="pre">ExLineParam</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPoint"><code class="docutils literal notranslate"><span class="pre">ExPoint</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPointParam"><code class="docutils literal notranslate"><span class="pre">ExPointParam</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPoly"><code class="docutils literal notranslate"><span class="pre">ExPoly</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPolyParam"><code class="docutils literal notranslate"><span class="pre">ExPolyParam</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.Geom"><code class="docutils literal notranslate"><span class="pre">Geom</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.GeomArch"><code class="docutils literal notranslate"><span class="pre">GeomArch</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.GeomLine"><code class="docutils literal notranslate"><span class="pre">GeomLine</span></code></a></li>
@@ -388,14 +385,11 @@
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.environment">fmdtools.define.environment</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.environment.Environment"><code class="docutils literal notranslate"><span class="pre">Environment</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.environment.ExampleEnvironment"><code class="docutils literal notranslate"><span class="pre">ExampleEnvironment</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.coords">fmdtools.define.coords</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.Coords"><code class="docutils literal notranslate"><span class="pre">Coords</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.CoordsParam"><code class="docutils literal notranslate"><span class="pre">CoordsParam</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.ExampleCoords"><code class="docutils literal notranslate"><span class="pre">ExampleCoords</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.ExampleCoordsParam"><code class="docutils literal notranslate"><span class="pre">ExampleCoordsParam</span></code></a></li>
 </ul>
 </li>
 </ul>

diff --git a/README.html b/README.html
@@ -197,6 +197,12 @@
 <li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Demonstration.html#Hierarchical-Model">Hierarchical Model</a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html">Urban Drone Demo</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html#Model-Overview">Model Overview</a></li>
+<li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html#Nominal-Simulation">Nominal Simulation</a></li>
+<li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Urban_Drone_Demo.html#Resilience-model">Resilience model</a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="examples/multirotor/Multirotor_Optimization.html">Integrated Resilience Optimization Architectures</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Multirotor_Optimization.html#Design-Model">Design Model</a></li>
 <li class="toctree-l4"><a class="reference internal" href="examples/multirotor/Multirotor_Optimization.html#Operational-Model">Operational Model</a></li>
@@ -358,7 +364,6 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.state">fmdtools.define.state</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.state.ExamplePoint"><code class="docutils literal notranslate"><span class="pre">ExamplePoint</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.state.State"><code class="docutils literal notranslate"><span class="pre">State</span></code></a></li>
 </ul>
 </li>
@@ -368,14 +373,6 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.geom">fmdtools.define.geom</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExGeomArch"><code class="docutils literal notranslate"><span class="pre">ExGeomArch</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExGeomState"><code class="docutils literal notranslate"><span class="pre">ExGeomState</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExLine"><code class="docutils literal notranslate"><span class="pre">ExLine</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExLineParam"><code class="docutils literal notranslate"><span class="pre">ExLineParam</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPoint"><code class="docutils literal notranslate"><span class="pre">ExPoint</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPointParam"><code class="docutils literal notranslate"><span class="pre">ExPointParam</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPoly"><code class="docutils literal notranslate"><span class="pre">ExPoly</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.ExPolyParam"><code class="docutils literal notranslate"><span class="pre">ExPolyParam</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.Geom"><code class="docutils literal notranslate"><span class="pre">Geom</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.GeomArch"><code class="docutils literal notranslate"><span class="pre">GeomArch</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.geom.GeomLine"><code class="docutils literal notranslate"><span class="pre">GeomLine</span></code></a></li>
@@ -388,14 +385,11 @@
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.environment">fmdtools.define.environment</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.environment.Environment"><code class="docutils literal notranslate"><span class="pre">Environment</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.environment.ExampleEnvironment"><code class="docutils literal notranslate"><span class="pre">ExampleEnvironment</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="docs/fmdtools.define.html#module-fmdtools.define.coords">fmdtools.define.coords</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.Coords"><code class="docutils literal notranslate"><span class="pre">Coords</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.CoordsParam"><code class="docutils literal notranslate"><span class="pre">CoordsParam</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.ExampleCoords"><code class="docutils literal notranslate"><span class="pre">ExampleCoords</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/fmdtools.define.html#fmdtools.define.coords.ExampleCoordsParam"><code class="docutils literal notranslate"><span class="pre">ExampleCoordsParam</span></code></a></li>
 </ul>
 </li>
 </ul>
@@ -710,7 +704,7 @@ <h3>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this
 </section>
 <section id="examples">
 <h3>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h3>
-<p>For tutorials, see the <a class="reference external" href="https://github.com/nasa/fmdtools/tree/main/examples">examples folder</a> and [examples page of the documentation]((https://nasa.github.io/fmdtools/examples/Examples.html). These folders include the following:</p>
+<p>For tutorials, see the <a class="reference external" href="https://github.com/nasa/fmdtools/tree/main/examples">examples folder</a> and <a class="reference external" href="https://nasa.github.io/fmdtools/examples/Examples.html">examples page of the documentation</a>. These folders include the following:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://github.com/nasa/fmdtools/tree/main/examples/asg_demo"><strong>asg_demo</strong></a>: A tutorial covering the use of the Action Sequence Graph in the FxnBlock class, which is useful for representing a Function’s Progress through a sequence of actions (e.g., modes of operation, etc).</p></li>
 <li><p><a class="reference external" href="https://github.com/nasa/fmdtools/tree/main/examples/eps"><strong>eps</strong></a>: A model of a simple electric power system in eps.py, which shows how undirected propagation can be used in a simple static (i.e., one time-step) moelling use-case.</p></li>

diff --git a/_sources/README.md.txt b/_sources/README.md.txt
@@ -104,7 +104,7 @@ They can be installed using ``pip install packagename``.
 
 ### Examples
 
-For tutorials, see the [examples folder](https://github.com/nasa/fmdtools/tree/main/examples) and [examples page of the documentation]((https://nasa.github.io/fmdtools/examples/Examples.html). These folders include the following: 
+For tutorials, see the [examples folder](https://github.com/nasa/fmdtools/tree/main/examples) and [examples page of the documentation](https://nasa.github.io/fmdtools/examples/Examples.html). These folders include the following: 
 
 - [**asg_demo**](https://github.com/nasa/fmdtools/tree/main/examples/asg_demo): A tutorial covering the use of the Action Sequence Graph in the FxnBlock class, which is useful for representing a Function's Progress through a sequence of actions \(e.g., modes of operation, etc\).
 

diff --git a/_sources/docs/fmdtools.define.rst.txt b/_sources/docs/fmdtools.define.rst.txt
@@ -96,8 +96,7 @@ fmdtools.define.state
 --------------------------------
 
 .. automodule:: fmdtools.define.state
- :members:
- :undoc-members:
+ :members: State
  :show-inheritance:
 
 fmdtools.define.time
@@ -112,23 +111,20 @@ fmdtools.define.geom
 --------------------------------
 
 .. automodule:: fmdtools.define.geom
- :members:
- :undoc-members:
+ :members: Geom, GeomPoint, PointParam, GeomLine, LineParam, GeomPoly, PolyParam, GeomArch
  :show-inheritance:
 
 fmdtools.define.environment
 --------------------------------
 
 .. automodule:: fmdtools.define.environment
- :members:
- :undoc-members:
+ :members: Environment
  :show-inheritance:
 
 
 fmdtools.define.coords
 --------------------------------
 
 .. automodule:: fmdtools.define.coords
- :members:
- :undoc-members:
- :show-inheritance:
+ :members: Coords, CoordsParam
+ :show-inheritance: