fmdtools 2.3.0__tar.gz → 2.3.2__tar.gz

{fmdtools-2.3.0 → fmdtools-2.3.2}/LICENSE

@@ -1,4 +1,4 @@
-fmdtools version 2.3.0
+fmdtools version 2.3.2
 ---------------------------
                                  Apache License
                            Version 2.0, January 2004

{fmdtools-2.3.0 → fmdtools-2.3.2}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: fmdtools
-Version: 2.3.0
+Version: 2.3.2
 Summary: System resilience modelling, simulation, and assessment in Python
 Author: fmdtools Developers
 Maintainer-email: Daniel Hulse <daniel.e.hulse@nasa.gov>
-License: fmdtools version 2.3.0
+License: fmdtools version 2.3.2
         ---------------------------
                                          Apache License
                                    Version 2.0, January 2004
@@ -253,10 +253,20 @@ Requires-Dist: matplotlib>=3.7.0
 Requires-Dist: pandas[all]
 Requires-Dist: ordered-set
 Requires-Dist: dill
-Requires-Dist: recordclass==0.23.1
+Requires-Dist: recordclass==0.24
 Requires-Dist: pytest
 Requires-Dist: graphviz
 Requires-Dist: shapely>=2.0
+Provides-Extra: examples
+Requires-Dist: deap; extra == "examples"
+Requires-Dist: pymoo; extra == "examples"
+Requires-Dist: scikit-learn; extra == "examples"
+Requires-Dist: multiprocess; extra == "examples"
+Requires-Dist: pathos; extra == "examples"
+Requires-Dist: adjustText; extra == "examples"
+Requires-Dist: jinja2; extra == "examples"
+Provides-Extra: all
+Requires-Dist: fmdtools[examples]; extra == "all"
 Dynamic: license-file
 
 [![fmdtools logo - titanic](/docs-source/figures/logo/logo-titanic.png)](https://github.com/nasa/fmdtools)
@@ -270,8 +280,8 @@ Dynamic: license-file
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/nasa/fmdtools?label=GitHub%20Release)](https://github.com/nasa/fmdtools/releases)
 [![GitHub Tag](https://img.shields.io/github/v/tag/nasa/fmdtools)](https://github.com/nasa/fmdtools/tags)
 [![CodeFactor](https://www.codefactor.io/repository/github/nasa/fmdtools/badge)](https://www.codefactor.io/repository/github/nasa/fmdtools)
-[![Tests Status](./reports/full-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py313/junit/report.html)
-[![Tests Coverage](./reports/full-py313/coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py313/coverage_html/index.html)
+[![Tests Status](./tests/reports/full-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/full-py313/junit/report.html)
+[![Tests Coverage](./tests/reports/full-py313/coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/full-py313/coverage_html/index.html)
 [![GitHub License](https://img.shields.io/badge/License-Apache%202.0-green)](https://github.com/nasa/fmdtools/blob/main/LICENSE)
 [![NASA Software Classification](https://img.shields.io/badge/Software_Class-E-blue)](https://nodis3.gsfc.nasa.gov/displayDir.cfm?Internal_ID=N_PR_7150_002D_&page_name=AppendixD)
 
@@ -279,6 +289,16 @@ Dynamic: license-file
 
 [Click here to view the the full documentation website.](https://nasa.github.io/fmdtools)
 
+### Demo Portfolio
+
+See: [Examples](https://nasa.github.io/fmdtools/examples/Examples.html)
+
+<img src="/docs/_images/tutorial_fmdtools_basics.webp" width="15%"></img>
+<img src="/docs/_images/demo_proxthreat.webp" width="15%"></img>
+<img src="/docs/_images/demo_wildfire.webp" width="15%"></img>
+<img src="/docs/_images/paper_jcise_dsa.webp" width="15%"></img>
+<img src="/docs/_images/demo_urban_flight.webp" width="15%"></img> 
+<img src="/docs/_images/demo_degradation.webp" width="15%"></img>
 
 ## About
 
@@ -310,11 +330,11 @@ The fmdtools library is developed in Python 3.13 but is tested to maintain compa
 
 | Python Version    | Doctests |
 | -------- | ------- |
-| 3.11  | [![Python 3.11 Tests](./reports/doctests-py311/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py311/junit/report.html)   |
-| 3.12 | [![Python 3.12 Tests](./reports/doctests-py312/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py312/junit/report.html)    |
-| 3.13    | [![Python 3.13 Tests](./reports/doctests-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py313/junit/report.html)   |
+| 3.11  | [![Python 3.11 Tests](./tests/reports/doctests-py311/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/doctests-py311/junit/report.html)   |
+| 3.12 | [![Python 3.12 Tests](./tests/reports/doctests-py312/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/doctests-py312/junit/report.html)    |
+| 3.13    | [![Python 3.13 Tests](./tests/reports/doctests-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/doctests-py313/junit/report.html)   |
 
-Further (functional and integration) tests are performed in the Python 3.13 to ensure that examples run as desired. Thus, it is generally reccommended to use Python 3.13 with this version to keep pace with development, especially when running examples.
+Further (functional and integration) tests are performed in the Python 3.13 to ensure that examples run as desired. Thus, it is generally recommended to use Python 3.13 with this version to keep pace with development, especially when running examples.
 
 ### Set up python tooling environment
 
@@ -355,25 +375,30 @@ For development as well as interactive use of tutorials and models, we reccomend
 For this installation, fmdtools can be downloaded from the [fmdtools github repository](https://github.com/nasa/fmdtools/) using:
 
 ```
+   cd /path/to/fmdtools
    git clone https://github.com/nasa/fmdtools.git
 ```
 
 This may then be installed using:
 
 ```
-   pip install -e "/path/to/fmdtools" 
+   pip install -e .[all] --group dev
 ```
 
-Note that this version reflects the latest version on the ``main`` git branch along with any local changes. To use a particular version of ``fmdtools`` you can checkout the tag corresponding to the version you want, e.g.:
+Which will install both fmdtools as well as examples (`[all]` option) as well as testing and development dependencies (`--group dev` option)
+
+More guidance on development installations is provided in [How to Contribute](https://nasa.github.io/fmdtools/docs-source/Contributions.html#how-to-contribute)
+
+Note that this version reflects the latest version on the ``main`` git branch along with any local changes. To use a particular version of ``fmdtools`` in the context of a development install you can checkout the tag corresponding to the version you want, e.g.:
 
 ```
-   git checkout v2.3.0
+   git checkout v2.3.2
 ```
 
 
 #### Dependencies
 
-fmdtools requires `Python 3.13` and depends directly on the packages below (see requirements.txt). Note that the use of these depencencies is governed by their respective licences, which may be obtained at the provided links.
+fmdtools requires `Python 3.13` and depends directly on the packages below (see requirements.txt). Note that the use of these dependencies is governed by their respective licenses, which may be obtained at the provided links.
 
 ```
 scipy
@@ -409,7 +434,7 @@ Some additional indirect dependencies (listed below) may be needed for developme
 deap
 # used for optimization of rover faults
 # license: (LGPL-3.0) https://github.com/DEAP/deap/blob/master/LICENSE.txt
-# the LGPL license and installation instructions are provided in ~/examples/rover/readme.rst
+# the LGPL license and installation instructions are provided in ~/examples/navigating_rover/readme.rst
 pymoo
 # used for optimization of tank and rover examples
 # license: (Apache 2.0) https://github.com/anyoptimization/pymoo/blob/main/LICENSE
@@ -447,14 +472,13 @@ One `fmdtools` is installed, you should be able to run:
 import fmdtools
 ```
 
-To check the version of fmdtools, you can run the following:
+To check the version of fmdtools, you can check:
 ```
-import importlib.metadata
-importlib.metadata.version("fmdtools")
+fmdtools.__version__
 ```
 which should return the current version of fmdtools.
 
-If a development install has been performed, you can further check aspects of your installation by running `run_all_tests.py` and opening the corresponding test report in `/reports/junit/report.html` to see if all tests pass (or, are consistent with the [current test report](https://github.com/nasa/fmdtools/blob/main/reports/junit/report.html)).
+If a development install has been performed, you can further check aspects of your installation by running `run_all_tests.py` and opening the corresponding test report in `tests/reports/junit/report.html` to see if all tests pass (or, are consistent with the [current test report](https://github.com/nasa/fmdtools/blob/main/tests/reports/junit/report.html)).
 
 ### Explore Tutorials and Resources
 
@@ -505,8 +529,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.3.0},
-  date = {2025-12-19},
+  version = {2.3.2},
+  date = {2025-3-6},
 }
 ```
 

{fmdtools-2.3.0 → fmdtools-2.3.2}/README.md

@@ -9,8 +9,8 @@
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/nasa/fmdtools?label=GitHub%20Release)](https://github.com/nasa/fmdtools/releases)
 [![GitHub Tag](https://img.shields.io/github/v/tag/nasa/fmdtools)](https://github.com/nasa/fmdtools/tags)
 [![CodeFactor](https://www.codefactor.io/repository/github/nasa/fmdtools/badge)](https://www.codefactor.io/repository/github/nasa/fmdtools)
-[![Tests Status](./reports/full-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py313/junit/report.html)
-[![Tests Coverage](./reports/full-py313/coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py313/coverage_html/index.html)
+[![Tests Status](./tests/reports/full-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/full-py313/junit/report.html)
+[![Tests Coverage](./tests/reports/full-py313/coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/full-py313/coverage_html/index.html)
 [![GitHub License](https://img.shields.io/badge/License-Apache%202.0-green)](https://github.com/nasa/fmdtools/blob/main/LICENSE)
 [![NASA Software Classification](https://img.shields.io/badge/Software_Class-E-blue)](https://nodis3.gsfc.nasa.gov/displayDir.cfm?Internal_ID=N_PR_7150_002D_&page_name=AppendixD)
 
@@ -18,6 +18,16 @@
 
 [Click here to view the the full documentation website.](https://nasa.github.io/fmdtools)
 
+### Demo Portfolio
+
+See: [Examples](https://nasa.github.io/fmdtools/examples/Examples.html)
+
+<img src="/docs/_images/tutorial_fmdtools_basics.webp" width="15%"></img>
+<img src="/docs/_images/demo_proxthreat.webp" width="15%"></img>
+<img src="/docs/_images/demo_wildfire.webp" width="15%"></img>
+<img src="/docs/_images/paper_jcise_dsa.webp" width="15%"></img>
+<img src="/docs/_images/demo_urban_flight.webp" width="15%"></img> 
+<img src="/docs/_images/demo_degradation.webp" width="15%"></img>
 
 ## About
 
@@ -49,11 +59,11 @@ The fmdtools library is developed in Python 3.13 but is tested to maintain compa
 
 | Python Version    | Doctests |
 | -------- | ------- |
-| 3.11  | [![Python 3.11 Tests](./reports/doctests-py311/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py311/junit/report.html)   |
-| 3.12 | [![Python 3.12 Tests](./reports/doctests-py312/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py312/junit/report.html)    |
-| 3.13    | [![Python 3.13 Tests](./reports/doctests-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py313/junit/report.html)   |
+| 3.11  | [![Python 3.11 Tests](./tests/reports/doctests-py311/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/doctests-py311/junit/report.html)   |
+| 3.12 | [![Python 3.12 Tests](./tests/reports/doctests-py312/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/doctests-py312/junit/report.html)    |
+| 3.13    | [![Python 3.13 Tests](./tests/reports/doctests-py313/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/tests/reports/doctests-py313/junit/report.html)   |
 
-Further (functional and integration) tests are performed in the Python 3.13 to ensure that examples run as desired. Thus, it is generally reccommended to use Python 3.13 with this version to keep pace with development, especially when running examples.
+Further (functional and integration) tests are performed in the Python 3.13 to ensure that examples run as desired. Thus, it is generally recommended to use Python 3.13 with this version to keep pace with development, especially when running examples.
 
 ### Set up python tooling environment
 
@@ -94,25 +104,30 @@ For development as well as interactive use of tutorials and models, we reccomend
 For this installation, fmdtools can be downloaded from the [fmdtools github repository](https://github.com/nasa/fmdtools/) using:
 
 ```
+   cd /path/to/fmdtools
    git clone https://github.com/nasa/fmdtools.git
 ```
 
 This may then be installed using:
 
 ```
-   pip install -e "/path/to/fmdtools" 
+   pip install -e .[all] --group dev
 ```
 
-Note that this version reflects the latest version on the ``main`` git branch along with any local changes. To use a particular version of ``fmdtools`` you can checkout the tag corresponding to the version you want, e.g.:
+Which will install both fmdtools as well as examples (`[all]` option) as well as testing and development dependencies (`--group dev` option)
+
+More guidance on development installations is provided in [How to Contribute](https://nasa.github.io/fmdtools/docs-source/Contributions.html#how-to-contribute)
+
+Note that this version reflects the latest version on the ``main`` git branch along with any local changes. To use a particular version of ``fmdtools`` in the context of a development install you can checkout the tag corresponding to the version you want, e.g.:
 
 ```
-   git checkout v2.3.0
+   git checkout v2.3.2
 ```
 
 
 #### Dependencies
 
-fmdtools requires `Python 3.13` and depends directly on the packages below (see requirements.txt). Note that the use of these depencencies is governed by their respective licences, which may be obtained at the provided links.
+fmdtools requires `Python 3.13` and depends directly on the packages below (see requirements.txt). Note that the use of these dependencies is governed by their respective licenses, which may be obtained at the provided links.
 
 ```
 scipy
@@ -148,7 +163,7 @@ Some additional indirect dependencies (listed below) may be needed for developme
 deap
 # used for optimization of rover faults
 # license: (LGPL-3.0) https://github.com/DEAP/deap/blob/master/LICENSE.txt
-# the LGPL license and installation instructions are provided in ~/examples/rover/readme.rst
+# the LGPL license and installation instructions are provided in ~/examples/navigating_rover/readme.rst
 pymoo
 # used for optimization of tank and rover examples
 # license: (Apache 2.0) https://github.com/anyoptimization/pymoo/blob/main/LICENSE
@@ -186,14 +201,13 @@ One `fmdtools` is installed, you should be able to run:
 import fmdtools
 ```
 
-To check the version of fmdtools, you can run the following:
+To check the version of fmdtools, you can check:
 ```
-import importlib.metadata
-importlib.metadata.version("fmdtools")
+fmdtools.__version__
 ```
 which should return the current version of fmdtools.
 
-If a development install has been performed, you can further check aspects of your installation by running `run_all_tests.py` and opening the corresponding test report in `/reports/junit/report.html` to see if all tests pass (or, are consistent with the [current test report](https://github.com/nasa/fmdtools/blob/main/reports/junit/report.html)).
+If a development install has been performed, you can further check aspects of your installation by running `run_all_tests.py` and opening the corresponding test report in `tests/reports/junit/report.html` to see if all tests pass (or, are consistent with the [current test report](https://github.com/nasa/fmdtools/blob/main/tests/reports/junit/report.html)).
 
 ### Explore Tutorials and Resources
 
@@ -244,8 +258,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.3.0},
-  date = {2025-12-19},
+  version = {2.3.2},
+  date = {2025-3-6},
 }
 ```
 

{fmdtools-2.3.0 → fmdtools-2.3.2}/examples/__init__.py

@@ -15,4 +15,5 @@ CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
 """
 
-__all__ = ['asg_demo', 'eps', 'multirotor', 'pump', 'rover', 'tank', 'taxiway' 'airspacelib']
+__all__ = ['human_hazard_mitigation', 'electric_power_system', 'state_communication',
+           'multirotor_drone', 'water_pump', 'rover', 'tank', 'taxiway' 'airspacelib']

fmdtools-2.3.0/examples/taxiway/asset.py → fmdtools-2.3.2/examples/airport_taxiway/model_asset.py

@@ -25,7 +25,8 @@ CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
 """
 
-from common import AssetParams, Location, Requests, Environment
+from fmdtools_examples.airport_taxiway.model_common import (AssetParams, Location,
+                                                            Requests, Environment)
 
 from fmdtools.define.container.state import State
 from fmdtools.define.container.mode import Mode

fmdtools-2.3.0/examples/taxiway/ATC.py → fmdtools-2.3.2/examples/airport_taxiway/model_atc.py

@@ -15,7 +15,8 @@ CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
 """
 
-from common import Location, Requests, TaxiwayParams, Environment
+from fmdtools_examples.airport_taxiway.model_common import (Location, Requests,
+                                                            TaxiwayParams, Environment)
 
 from fmdtools.define.block.function import Function
 from fmdtools.define.container.mode import Mode

fmdtools-2.3.0/examples/taxiway/common.py → fmdtools-2.3.2/examples/airport_taxiway/model_common.py

@@ -27,7 +27,9 @@ from fmdtools.define.flow.multiflow import MultiFlow
 from fmdtools.define.flow.commsflow import CommsFlow
 from fmdtools.define.container.parameter import Parameter
 from fmdtools.define.container.state import State
-from fmdtools.analyze.common import consolidate_legend
+from fmdtools.define.base import filter_kwargs
+from fmdtools.analyze.common import consolidate_legend, setup_plot, add_title_xylabs
+from fmdtools.analyze.common import prep_animation_title, clear_prev_figure
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -391,7 +393,8 @@ class Environment(MultiFlow):
             self.s.area_allocation[new_area].add(asset)
 
     def show_map(self, legend=False, figsize=(6.5, 3.5), show_area_allocation=False,
-                 areas_to_label=["gate", "landing", "helipad", "takeoff"]):
+                 areas_to_label=["gate", "landing", "helipad", "takeoff"],
+                 fig=None, ax=None):
         """
         Show the map as a plot.
 
@@ -407,7 +410,7 @@ class Environment(MultiFlow):
         fig: matplotlib figure
         ax: matplotlib axis
         """
-        fig, ax = plt.subplots(figsize=figsize)
+        fig, ax = setup_plot(fig=fig, ax=ax, figsize=figsize)
         airspace = plt.Rectangle(
             (self.p.air_loc[0] - 5, self.p.air_loc[1] - 5),
             10,
@@ -416,7 +419,7 @@ class Environment(MultiFlow):
             ec="blue",
         )
         ax.add_patch(airspace)
-        plt.text(
+        ax.text(
             self.p.air_loc[0],
             self.p.air_loc[1] + 5,
             "In Air",
@@ -441,7 +444,7 @@ class Environment(MultiFlow):
                 else:
                     area_text = "\n" + str(entry)
                 text = segname + area_text
-                plt.text(
+                ax.text(
                     lineobj.centroid.xy[0][0],
                     lineobj.centroid.xy[1][0],
                     text,
@@ -457,7 +460,7 @@ class Environment(MultiFlow):
 
         if legend:
             consolidate_legend(ax)
-        plt.axis('off')
+        ax.axis('off')
         return fig, ax
 
     def show_route(self, routename, color="red", legend=True, **kwargs):
@@ -743,7 +746,7 @@ def att_to_text(att):
     return str(att)
 
 
-def plot_tstep(mdl, mdlhist, t, fxnattr="", locattr="", markersize=10,
+def plot_tstep(t, history={}, mdl=None, fxnattr="", locattr="", markersize=10,
                show_area_allocation=True, asset_assignment=False, title="",
                assets_to_label="all", **kwargs):
     """
@@ -751,12 +754,12 @@ def plot_tstep(mdl, mdlhist, t, fxnattr="", locattr="", markersize=10,
 
     Parameters
     ----------
-    mdl : model
-        model with ground and Location
-    mdlhist : dict
-        Model history
     t : int
         time-step to plot
+    mdlhist : dict
+        Model history
+    mdl : model
+        model with ground and Location
     fxnattr : str
         function attribute to display on the plot (e.g., visioncov, mode, segment)
     locattr : str
@@ -778,22 +781,23 @@ def plot_tstep(mdl, mdlhist, t, fxnattr="", locattr="", markersize=10,
     ax: matplotlib axis
 
     """
+    kwargs = clear_prev_figure(**kwargs)
+    # fig, ax = setup_plot(**kwargs)
     if show_area_allocation == "size":
         show_area_allocation = {
             pl: len(plhist[t])
-            for pl, plhist in mdlhist.flows.ground.s.area_allocation.items()
+            for pl, plhist in history.flows.ground.s.area_allocation.items()
         }
     elif show_area_allocation:
         show_area_allocation = {
             pl: plhist[t]
-            for pl, plhist in mdlhist.flows.ground.s.area_allocation.items()
+            for pl, plhist in history.flows.ground.s.area_allocation.items()
         }
     fig, ax = mdl.flows["ground"].show_map(
-        **kwargs, show_area_allocation=show_area_allocation
-    )
+        **kwargs, show_area_allocation=show_area_allocation)
     texts = []
     for f in mdl.flows["location"].locals:
-        loc = mdlhist.flows.location.get(f)
+        loc = history.flows.location.get(f)
         x, y = loc.s.x[t], loc.s.y[t]
         xd, yd = loc.s.xd[t], loc.s.yd[t]
         mode, stage = loc.s.mode[t], loc.s.stage[t]
@@ -816,25 +820,25 @@ def plot_tstep(mdl, mdlhist, t, fxnattr="", locattr="", markersize=10,
             markeredgecolor = "purple"
         else:
             markeredgecolor = "grey"
-        plt.plot(x, y, marker=marker, markersize=markersize,
+        ax.plot(x, y, marker=marker, markersize=markersize,
                  markeredgecolor=markeredgecolor, color=color)
         text = f
         if assets_to_label == "all" or f in assets_to_label:
             if fxnattr:
                 try:
-                    atthist = mdlhist.fxns.get(f + "." + fxnattr)
+                    atthist = history.fxns.get(f + "." + fxnattr)
                 except Exception or AttributeError:
                     atthist = None
                 if (not atthist is None) and len(atthist) > 0:
                     if fxnattr == "s.visioncov" and atthist[t]:
-                        plt.plot(*atthist[t].exterior.xy)
+                        ax.plot(*atthist[t].exterior.xy)
                     if fxnattr in ["mode", "segment"]:
-                        text_add = mdlhist.fxns.get(f + "." + fxnattr)[t]
+                        text_add = history.fxns.get(f + "." + fxnattr)[t]
                         text = text + ": " + text_add
                     if fxnattr == "faults":
                         faults = {
                             fault
-                            for fault, hist in mdlhist.fxns["functions"][f][
+                            for fault, hist in history.fxns["functions"][f][
                                 "faults"
                             ].items()
                             if hist[t]
@@ -843,17 +847,20 @@ def plot_tstep(mdl, mdlhist, t, fxnattr="", locattr="", markersize=10,
                             text = text + ": " + str(faults)
             if locattr:
                 text_add = att_to_text(
-                    mdlhist.flows.location.get(f + ".s." + locattr)[t]
+                    history.flows.location.get(f + ".s." + locattr)[t]
                 )
                 text = text + ": " + text_add
             if asset_assignment:
-                assignment = str(mdlhist.fxns["ground"]["asset_assignment"][f][t])
-                area = str(mdlhist.fxns["ground"]["asset_area"][f][t])
+                assignment = str(history.fxns["ground"]["asset_assignment"][f][t])
+                area = str(history.fxns["ground"]["asset_area"][f][t])
                 text = text + ": (" + area + "->" + assignment + ")"
             textax = plt.text(x, y, text)
             texts.append(textax)
     if texts:
+        # note - may print to console--known issue with adjustText 1.3.0
         adjust_text(texts)
-    plt.title(title + "(t=" + str(t) + ")")
-    plt.axis('off')
+    _ = kwargs.pop('fig', None)
+    add_title_xylabs(ax, title=prep_animation_title(t, title=title),
+                     **filter_kwargs(add_title_xylabs, **kwargs))
+    ax.axis('off')
     return fig, ax

fmdtools-2.3.0/examples/taxiway/model.py → fmdtools-2.3.2/examples/airport_taxiway/model_main.py

@@ -17,17 +17,16 @@ CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
 """
 
-from ATC import ATC
-from asset import Aircraft, Helicopter
-from common import (
-    TaxiwayParams,
-    Environment,
-    Location,
-    Requests,
-    plot_course,
-    plot_one_path,
-    plot_tstep,
-)
+from fmdtools_examples.airport_taxiway.model_atc import ATC
+from fmdtools_examples.airport_taxiway.model_asset import Aircraft, Helicopter
+from fmdtools_examples.airport_taxiway.model_common import (TaxiwayParams,
+                                                            Environment,
+                                                            Location,
+                                                            Requests,
+                                                            plot_course,
+                                                            plot_one_path,
+                                                            plot_tstep,
+                                                        )
 
 from fmdtools.define.architecture.function import FunctionArchitecture
 from fmdtools.sim import propagate as prop
@@ -133,19 +132,33 @@ if __name__ == "__main__":
 
     mdl = taxiway_model()
 
+
+    endresults, mdlhist = prop.one_fault(mdl, "ma3", "lost_sight",
+                                        to_return={93: {"graph.flows.location": {'with_root':False, 'with_methods': False}},
+                                                   110:{"graph.flows.location": {'with_root': False, 'with_methods': False}}, 
+                                                   20:["graph"], 120:['graph', "classify"]})
+    plot_tstep(50, history=mdlhist.faulty, mdl=mdl, fxnattr="s.visioncov")
+    endresults.faulty.t93p0.graph.flows.location
+
     mg = mdl.as_modelgraph()
     mg.draw()
 
-    ground_args = {'include_glob':True, "include_containers": ['s'],
+    ground_args = {'with_root':True, "include_containers": ['s'],
               'send_connections':{"asset_area":"asset_area", 
                                   "area_allocation":"area_allocation",
                                   "asset_assignment":"asset_assignment"}}
-    req_args = {'include_glob':False, "ports_only":True}
+    req_args = {'with_root':False, "ports_only":True}
+
+    endresults, mdlhist = prop.sequence(mdl, faultseq={7:{"atc": ["wrong_land_command"]}, 9: {"ua2":["lost_sight"]}}, 
+                                         to_return={93: {"graph.flows.location": {'with_root':False, 'with_methods': False}},
+                                                    110:{"graph.flows.location": {'with_root': False, 'with_methods': False}}, 
+                                                    20:["graph"], 120:['graph', "classify"]})
+
     endresults, mdlhist = prop.sequence(mdl, faultseq={7:{"atc": ["wrong_land_command"]}, 9: {"ua2":["lost_sight"]}}, 
                                          to_return={10:{"graph.flows.requests":(CommsFlowGraph, req_args)},
                                                     11:{"graph.flows.requests":(CommsFlowGraph, req_args),
                                                         "graph.flows.ground":(MultiFlowGraph, ground_args)},
-                                                    19:{"graph.flows.requests":{'include_glob':False, "ports_only":True}},
+                                                    19:{"graph.flows.requests":{'with_root':False, "ports_only":True}},
                                                     20:["graph"], 120: "classify"})
     ind_hist = create_fault_scen_metrics(mdlhist)
     fig, ax = ind_hist.plot_line("degraded_fields",
@@ -160,8 +173,8 @@ if __name__ == "__main__":
         "ma3",
         "lost_sight",
         to_return={
-            93: {"graph.flows.location": {"include_glob": False}},
-            110: {"graph.flows.location": {"include_glob": False}},
+            93: {"graph.flows.location": {"with_root": False}},
+            110: {"graph.flows.location": {"with_root": False}},
             20: ["graph"],
             120: ["graph", "classify"],
         },
@@ -186,11 +199,11 @@ if __name__ == "__main__":
     plot_course(mdl, mdlhist, "ua2")
     plot_course(mdl, mdlhist, "ua3")
 
-    plot_tstep(mdl, mdlhist, 50, fxnattr="s.visioncov")
-    plot_tstep(mdl, mdlhist, 75, fxnattr="s.visioncov")
-    plot_tstep(mdl, mdlhist, 100, fxnattr="s.visioncov")
-    plot_tstep(mdl, mdlhist, 110, fxnattr="s.visioncov")
-    plot_tstep(mdl, mdlhist, 115, fxnattr="s.visioncov")
+    plot_tstep(50, history=mdlhist, mdl=mdl, fxnattr="s.visioncov")
+    plot_tstep(75, history=mdlhist, mdl=mdl, fxnattr="s.visioncov")
+    plot_tstep(100, history=mdlhist, mdl=mdl, fxnattr="s.visioncov")
+    plot_tstep(110, history=mdlhist, mdl=mdl, fxnattr="s.visioncov")
+    plot_tstep(115, history=mdlhist, mdl=mdl, fxnattr="s.visioncov")
 
     vals = {"flows": {"location": {"ua2": {"s": {"x", "y", "speed", "mode", "stage"}}}}}
     mdlhist.plot_line(vals)
@@ -210,8 +223,8 @@ if __name__ == "__main__":
             120: "classify",
         },
     )
-    plot_tstep(mdl, mdlhist.faulty, 110, title="Aircraft crashed")
-    plot_tstep(mdl, mdlhist.faulty, 25, fxnattr="visioncov", areas_to_label=[])
+    plot_tstep(110, mdl=mdl, history=mdlhist.faulty, title="Aircraft crashed")
+    plot_tstep(25, mdl=mdl, history=mdlhist.faulty, fxnattr="visioncov", areas_to_label=[])
 
     ind_hist = create_fault_scen_metrics(mdlhist)
     fig, ax = ind_hist.plot_line("degraded_fields",