fmdtools 2.0.3__tar.gz → 2.0.4__tar.gz

{fmdtools-2.0.3 → fmdtools-2.0.4}/LICENSE

@@ -1,4 +1,4 @@
-fmdtools version 2.0.3
+fmdtools version 2.0.4
 ---------------------------
                                  Apache License
                            Version 2.0, January 2004

{fmdtools-2.0.3/fmdtools.egg-info → fmdtools-2.0.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: fmdtools
-Version: 2.0.3
+Version: 2.0.4
 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.0.3
+License: fmdtools version 2.0.4
         ---------------------------
                                          Apache License
                                    Version 2.0, January 2004
@@ -251,22 +251,24 @@ Requires-Dist: matplotlib>=3.7.0
 Requires-Dist: pandas
 Requires-Dist: ordered-set
 Requires-Dist: dill
-Requires-Dist: recordclass==0.21.1
+Requires-Dist: recordclass==0.22.1
 Requires-Dist: pytest
 Requires-Dist: graphviz
 Requires-Dist: shapely>=2.0
 
-[![fmdtools logo - titanic](/docs/figures/logo/logo-titanic.png)](https://github.com/nasa/fmdtools)
+[![fmdtools logo - titanic](/docs-source/figures/logo/logo-titanic.png)](https://github.com/nasa/fmdtools)
 
 # Overview
 
 ![Python Version](https://img.shields.io/badge/Python-3.11-blue)
 [![PyPI](https://img.shields.io/pypi/v/fmdtools)](https://pypi.org/project/fmdtools/)
+[![Total Downloads](https://static.pepy.tech/badge/fmdtools)](https://pepy.tech/project/fmdtools)
+[![Downloads/Month](https://static.pepy.tech/badge/fmdtools/month)](https://pepy.tech/project/fmdtools)
 [![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](./tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/junit/report.html)
-[![Tests Coverage](./coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/coverage/index.html)
+[![Tests Status](./reports/full-py311/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py311/junit/report.html)
+[![Tests Coverage](./reports/full-py311/coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py311/coverage/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)
 
@@ -274,21 +276,22 @@ Requires-Dist: shapely>=2.0
 
 [Click here to view the the full documentation website.](https://nasa.github.io/fmdtools)
 
+
 ## About
 
-The fmdtools library provides the computational support needed to perform a simulation-based (rather than document-based) hazard analysis process that [**enables the consideration of systems resilience**](https://nasa.github.io/fmdtools/docs/Development%20Guide.html#why-fmdtools). This means that it can be used to extend the scope of hazard analysis from component faults to the dynamic interactions between the system, operators, and the environment. Some key features include:
+The fmdtools library provides the computational support needed to perform a simulation-based (rather than document-based) hazard analysis process that [**enables the consideration of systems resilience**](https://nasa.github.io/fmdtools/docs-source/Development%20Guide.html#why-fmdtools). This means that it can be used to extend the scope of hazard analysis from component faults to the dynamic interactions between the system, operators, and the environment. Some key features include:
 
-<img align="left" width="100" height="100" src="/docs/figures/powerpoint/flexible.svg">
+<img align="left" width="100" height="100" src="/docs-source/figures/powerpoint/flexible.svg">
 
 ### Flexible Modelling Paradigm
 Models in fmdtools use a consistent and composable representation of system structure and behavior. Whether you want to model a simple component, a complex system-of-systems, or both, fmdtools can help.
 
-<img align="left" width="100" height="100" src="/docs/figures/powerpoint/powerful.svg">
+<img align="left" width="100" height="100" src="/docs-source/figures/powerpoint/powerful.svg">
 
 ### Powerful Simulation Techniques
 Simulation techniques in fmdtools represent the state-of-the-art in dynamical systems modelling for resilience quantification. With fmdtools, you can simulate the dynamic effects of hazardous scenarios over a wide range of variables to quantify and optimize risk, resilience, and safety metrics. 
 
-<img align="left" width="100" height="100" src="/docs/figures/powerpoint/efficient.svg"> 
+<img align="left" width="100" height="100" src="/docs-source/figures/powerpoint/efficient.svg"> 
 
 ### Efficient Analysis Process
 Readily-deployable analysis methods are built in to fmdtools to enable the rapid and iterative statistical analysis of simulation results. With fmdtools, you can write 2-3 lines of code to visualize model behavior instead of spending hours writing it yourself.
@@ -297,6 +300,18 @@ Readily-deployable analysis methods are built in to fmdtools to enable the rapid
 
 ## Getting Started
 
+### Python version compatibility
+
+The fmdtools library is developed in Python 3.11 but tested to maintain compatibility over three versions of Python. See current doctest reports below:
+
+| Python Version    | Doctests |
+| -------- | ------- |
+| 3.10  | [![Python 3.10 Tests](./reports/doctests-py310/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py310/junit/report.html)   |
+| 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)   |
+
+Further (functional and integration) tests are performed in the Python 3.11 to ensure that examples run as desired. Thus, it is generally reccommended to use Python 3.11 to keep pace with development, especially when running examples.
+
 ### Set up python environment
 
 The fmdtools library was developed to run in an anaconda python environment. If you do not have an existing python environment, first [download and install anaconda.](https://docs.anaconda.com/free/anaconda/install/index.html).
@@ -314,7 +329,7 @@ graphviz
 # install from: https://anaconda.org/anaconda/graphviz
 ```
 
-Note: some versions `fmdtools` dependencies may additionally require `Microsoft Studio Build tools <https://visualstudio.microsoft.com/license-terms/vs2022-ga-diagnosticbuildtools/>`_ to build properly, so it may be helpful to install it also.
+Note: On Windows, some versions `fmdtools` dependencies may require a compiler such as that provided with [Microsoft Studio Build tools](https://visualstudio.microsoft.com/downloads/?q=build+tools) to build, so it (while not required) may be helpful to install it also.
 
 
 ### Install fmdtools
@@ -340,7 +355,7 @@ This may then be installed using:
 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.:
 
 ```
-   git checkout v2.0.3
+   git checkout v2.0.4
 ```
 
 
@@ -365,7 +380,7 @@ ordered-set
 # license: (MIT) https://github.com/rspeer/ordered-set/blob/master/MIT-LICENSE
 dill 
 # license: (MIT) https://github.com/uqfoundation/dill/blob/master/LICENSE
-recordclass == 0.21.1
+recordclass == 0.22.1
 # license: (MIT) https://github.com/intellimath/recordclass/blob/main/LICENSE.txt
 pytest
 # license: (MIT) https://docs.pytest.org/en/7.3.x/license.html
@@ -433,13 +448,13 @@ If a development install has been performed, you can further check aspects of yo
 
 Once fmdtools is installed, use the following to get acquainted with how to use the library:
 
-- Go through the [Intro to fmdtools workshop](https://nasa.github.io/fmdtools/docs/Intro_to_fmdtools.html) to learn about some of the basics of the fmdtools library and work with an existing model. 
+- Go through the [Intro to fmdtools workshop](https://nasa.github.io/fmdtools/docs-source/Intro_to_fmdtools.html) to learn about some of the basics of the fmdtools library and work with an existing model. 
 
 - Explore more [examples](https://nasa.github.io/fmdtools/examples/Examples.html) of particular use-cases by going through the [examples folder](https://github.com/nasa/fmdtools/tree/main/examples)
 
-- Read about contributions and model development best practices by perusing the [Development Guide](https://nasa.github.io/fmdtools/docs/Development%20Guide.html#).
+- Read about contributions and model development best practices by perusing the [Development Guide](https://nasa.github.io/fmdtools/docs-source/Development%20Guide.html#).
 
-- Explore the searchable [module reference](https://nasa.github.io/fmdtools/docs/fmdtools.html) for syntax and usage documentation.
+- Explore the searchable [module reference](https://nasa.github.io/fmdtools/docs-source/fmdtools.html) for syntax and usage documentation.
 
 ## Contributions
 fmdtools is developed primarily by researchers at NASA Ames Research Center. External contributions are welcome under a Contributor License Agreement:
@@ -478,8 +493,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.0.3}, # <- replace with your version number
-  date = {2024-08-22},
+  version = {2.0.4}, # <- replace with your version number
+  date = {2024-10-25},
 }
 ```
 

{fmdtools-2.0.3 → fmdtools-2.0.4}/README.md

@@ -1,14 +1,16 @@
-[![fmdtools logo - titanic](/docs/figures/logo/logo-titanic.png)](https://github.com/nasa/fmdtools)
+[![fmdtools logo - titanic](/docs-source/figures/logo/logo-titanic.png)](https://github.com/nasa/fmdtools)
 
 # Overview
 
 ![Python Version](https://img.shields.io/badge/Python-3.11-blue)
 [![PyPI](https://img.shields.io/pypi/v/fmdtools)](https://pypi.org/project/fmdtools/)
+[![Total Downloads](https://static.pepy.tech/badge/fmdtools)](https://pepy.tech/project/fmdtools)
+[![Downloads/Month](https://static.pepy.tech/badge/fmdtools/month)](https://pepy.tech/project/fmdtools)
 [![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](./tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/junit/report.html)
-[![Tests Coverage](./coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/coverage/index.html)
+[![Tests Status](./reports/full-py311/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py311/junit/report.html)
+[![Tests Coverage](./reports/full-py311/coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/full-py311/coverage/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)
 
@@ -16,21 +18,22 @@
 
 [Click here to view the the full documentation website.](https://nasa.github.io/fmdtools)
 
+
 ## About
 
-The fmdtools library provides the computational support needed to perform a simulation-based (rather than document-based) hazard analysis process that [**enables the consideration of systems resilience**](https://nasa.github.io/fmdtools/docs/Development%20Guide.html#why-fmdtools). This means that it can be used to extend the scope of hazard analysis from component faults to the dynamic interactions between the system, operators, and the environment. Some key features include:
+The fmdtools library provides the computational support needed to perform a simulation-based (rather than document-based) hazard analysis process that [**enables the consideration of systems resilience**](https://nasa.github.io/fmdtools/docs-source/Development%20Guide.html#why-fmdtools). This means that it can be used to extend the scope of hazard analysis from component faults to the dynamic interactions between the system, operators, and the environment. Some key features include:
 
-<img align="left" width="100" height="100" src="/docs/figures/powerpoint/flexible.svg">
+<img align="left" width="100" height="100" src="/docs-source/figures/powerpoint/flexible.svg">
 
 ### Flexible Modelling Paradigm
 Models in fmdtools use a consistent and composable representation of system structure and behavior. Whether you want to model a simple component, a complex system-of-systems, or both, fmdtools can help.
 
-<img align="left" width="100" height="100" src="/docs/figures/powerpoint/powerful.svg">
+<img align="left" width="100" height="100" src="/docs-source/figures/powerpoint/powerful.svg">
 
 ### Powerful Simulation Techniques
 Simulation techniques in fmdtools represent the state-of-the-art in dynamical systems modelling for resilience quantification. With fmdtools, you can simulate the dynamic effects of hazardous scenarios over a wide range of variables to quantify and optimize risk, resilience, and safety metrics. 
 
-<img align="left" width="100" height="100" src="/docs/figures/powerpoint/efficient.svg"> 
+<img align="left" width="100" height="100" src="/docs-source/figures/powerpoint/efficient.svg"> 
 
 ### Efficient Analysis Process
 Readily-deployable analysis methods are built in to fmdtools to enable the rapid and iterative statistical analysis of simulation results. With fmdtools, you can write 2-3 lines of code to visualize model behavior instead of spending hours writing it yourself.
@@ -39,6 +42,18 @@ Readily-deployable analysis methods are built in to fmdtools to enable the rapid
 
 ## Getting Started
 
+### Python version compatibility
+
+The fmdtools library is developed in Python 3.11 but tested to maintain compatibility over three versions of Python. See current doctest reports below:
+
+| Python Version    | Doctests |
+| -------- | ------- |
+| 3.10  | [![Python 3.10 Tests](./reports/doctests-py310/tests-badge.svg)](https://htmlpreview.github.io/?https://github.com/nasa/fmdtools/blob/main/reports/doctests-py310/junit/report.html)   |
+| 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)   |
+
+Further (functional and integration) tests are performed in the Python 3.11 to ensure that examples run as desired. Thus, it is generally reccommended to use Python 3.11 to keep pace with development, especially when running examples.
+
 ### Set up python environment
 
 The fmdtools library was developed to run in an anaconda python environment. If you do not have an existing python environment, first [download and install anaconda.](https://docs.anaconda.com/free/anaconda/install/index.html).
@@ -56,7 +71,7 @@ graphviz
 # install from: https://anaconda.org/anaconda/graphviz
 ```
 
-Note: some versions `fmdtools` dependencies may additionally require `Microsoft Studio Build tools <https://visualstudio.microsoft.com/license-terms/vs2022-ga-diagnosticbuildtools/>`_ to build properly, so it may be helpful to install it also.
+Note: On Windows, some versions `fmdtools` dependencies may require a compiler such as that provided with [Microsoft Studio Build tools](https://visualstudio.microsoft.com/downloads/?q=build+tools) to build, so it (while not required) may be helpful to install it also.
 
 
 ### Install fmdtools
@@ -82,7 +97,7 @@ This may then be installed using:
 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.:
 
 ```
-   git checkout v2.0.3
+   git checkout v2.0.4
 ```
 
 
@@ -107,7 +122,7 @@ ordered-set
 # license: (MIT) https://github.com/rspeer/ordered-set/blob/master/MIT-LICENSE
 dill 
 # license: (MIT) https://github.com/uqfoundation/dill/blob/master/LICENSE
-recordclass == 0.21.1
+recordclass == 0.22.1
 # license: (MIT) https://github.com/intellimath/recordclass/blob/main/LICENSE.txt
 pytest
 # license: (MIT) https://docs.pytest.org/en/7.3.x/license.html
@@ -175,13 +190,13 @@ If a development install has been performed, you can further check aspects of yo
 
 Once fmdtools is installed, use the following to get acquainted with how to use the library:
 
-- Go through the [Intro to fmdtools workshop](https://nasa.github.io/fmdtools/docs/Intro_to_fmdtools.html) to learn about some of the basics of the fmdtools library and work with an existing model. 
+- Go through the [Intro to fmdtools workshop](https://nasa.github.io/fmdtools/docs-source/Intro_to_fmdtools.html) to learn about some of the basics of the fmdtools library and work with an existing model. 
 
 - Explore more [examples](https://nasa.github.io/fmdtools/examples/Examples.html) of particular use-cases by going through the [examples folder](https://github.com/nasa/fmdtools/tree/main/examples)
 
-- Read about contributions and model development best practices by perusing the [Development Guide](https://nasa.github.io/fmdtools/docs/Development%20Guide.html#).
+- Read about contributions and model development best practices by perusing the [Development Guide](https://nasa.github.io/fmdtools/docs-source/Development%20Guide.html#).
 
-- Explore the searchable [module reference](https://nasa.github.io/fmdtools/docs/fmdtools.html) for syntax and usage documentation.
+- Explore the searchable [module reference](https://nasa.github.io/fmdtools/docs-source/fmdtools.html) for syntax and usage documentation.
 
 ## Contributions
 fmdtools is developed primarily by researchers at NASA Ames Research Center. External contributions are welcome under a Contributor License Agreement:
@@ -220,8 +235,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.0.3}, # <- replace with your version number
-  date = {2024-08-22},
+  version = {2.0.4}, # <- replace with your version number
+  date = {2024-10-25},
 }
 ```
 

{fmdtools-2.0.3 → fmdtools-2.0.4}/examples/pump/ex_pump.py

@@ -672,6 +672,7 @@ if __name__ == "__main__":
     Pump().get_vars("flows.ee_1")
     g = Pump().create_graph()
     from fmdtools.analyze.graph.base import Graph
+    from fmdtools.define.object.base import ObjectGraph
     # horizontal alignment test:
     g2 = Graph(g)
     g2.set_node_labels(subtext="nodetype", title_style={'horizontalalignment': 'left'},
@@ -685,3 +686,6 @@ if __name__ == "__main__":
     check_model_pickleability(Pump(), try_pick=True)
     import inspect
     source = inspect.getsource(Pump)
+    og = ObjectGraph(Pump(), get_source=True)
+    og.set_node_labels(title='shortname', title2='classname', subtext='docs')
+    og.draw_graphviz()

{fmdtools-2.0.3 → fmdtools-2.0.4}/fmdtools/__init__.py

@@ -22,6 +22,6 @@ import fmdtools.sim as sim
 import fmdtools.analyze as analyze
 
 __all__ = ['analyze', 'sim', 'define']
-__version__ = '2.0.0'
+__version__ = '2.0.4'
 __copyright__ = "Copyright 2024 United States Government"
 __license__ = "Apache-2.0"

{fmdtools-2.0.3 → fmdtools-2.0.4}/fmdtools/analyze/graph/base.py

@@ -86,7 +86,7 @@ class Graph(object):
     >>> graph.set_pos(auto='kamada_kawai')
     >>> fig, ax = graph.draw(saveas=loc+'nx_funcdecomp.svg')
     >>> graph.set_edge_labels(title="name")
-    >>> dot = graph.draw_graphviz(saveas=loc+'gv_funcdecomp.svg')
+    >>> dot = graph.draw_graphviz(disp=False, saveas=loc+'gv_funcdecomp.svg')
     """
 
     def __init__(self, g, check_info=True):

{fmdtools-2.0.3 → fmdtools-2.0.4}/fmdtools/analyze/graph/model.py

@@ -30,7 +30,7 @@ under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
 """
-from fmdtools.define.base import get_code_attrs, get_obj_name
+from fmdtools.define.base import get_code_attrs, get_obj_name, get_inheritance
 from fmdtools.analyze.graph.base import Graph
 from fmdtools.analyze.graph.label import shorten_name
 from fmdtools.analyze.result import Result
@@ -58,12 +58,12 @@ def add_node(obj, g=None, name='', classname='', nodetype='', get_attrs=False,
     """
     if not g:
         g = nx.DiGraph()
-    if hasattr(obj, 'get_full_name'):
-        name = obj.get_full_name()
+    if not name:
+        name = get_obj_name(obj)
     if not classname:
         classname = obj.__class__.__name__
     if not nodetype:
-        if hasattr(obj, 'get_typename'):
+        if hasattr(obj, 'get_typename') and not inspect.isclass(obj):
             nodetype = obj.get_typename()
         else:
             nodetype = obj.__class__.__name__
@@ -103,6 +103,41 @@ def add_edge(g, basename, name, rolename, edgetype):
     g.add_edge(basename, name, edgetype=edgetype, role=rolename)
 
 
+def create_inheritance_subgraph(obj, g=None, name='', end_at_fmdtools=True):
+    """
+    Create a graph of the inheritance of a given object from fmdtools classes.
+
+    Parameters
+    ----------
+    obj : Object
+        Object.
+    g : graph, optional
+        Networkx graph to add to. The default is None.
+    end_at_fmdtools : bool
+        Option to end at first fmdtools node while building the subgraph
+        Default is False, which stops the subgraph at the first fmdtools class, rather
+        than includeing the fmdtools class inheritance.
+
+    Returns
+    -------
+    g : graph
+        Networkx graph of inheritance from classes.
+    """
+    if not name:
+        name = get_obj_name(obj)
+    if inspect.isclass(obj):
+        nodetype = "class"
+        g = add_node(obj, g, name=name, nodetype=nodetype)
+    else:
+        g = add_node(obj, g, name=name)
+    if not (end_at_fmdtools and 'fmdtools.' in name):
+        base_classes = get_inheritance(obj)
+        for bc in base_classes:
+            g = create_inheritance_subgraph(bc, g, end_at_fmdtools=end_at_fmdtools)
+            add_edge(g, name, get_obj_name(bc), "base", "inheritance")
+    return g
+
+
 def set_node_states(g, obj, name, time=None):
     """
     Attach stateful attributes to the given node.
@@ -155,7 +190,6 @@ def remove_base(g, basename):
     g.remove_nodes_from([*nx.isolates(g)])
 
 
-
 class ModelGraph(Graph):
     """
     Superclass for Graphs meant to represent specific model constructs.

{fmdtools-2.0.3 → fmdtools-2.0.4}/fmdtools/analyze/graph/style.py

@@ -87,9 +87,9 @@ def mod_prefix():
     import os
     wd = os.getcwd()
     if 'graph' in wd:
-        return '../../../docs/figures/frdl/'
+        return '../../../docs-source/figures/frdl/'
     else:
-        return 'docs/figures/frdl/'
+        return 'docs-source/figures/frdl/'
 
 
 class BaseStyle(dataobject, copy_default=True):
@@ -199,7 +199,7 @@ def save_dot(dot, saveas=''):
     """Save a graphviz diagram."""
     if saveas:
         filecomponents = saveas.split('.')
-        dot.render('.'.join(filecomponents[:-1]), format=filecomponents[-1])
+        dot.render('.'.join(filecomponents[:-1]), format=filecomponents[-1], view=False)
 
 
 class FlowEdgeStyle(EdgeStyle):
@@ -267,6 +267,19 @@ class ConnectionEdgeStyle(EdgeStyle):
     gv_style: str = 'dashed'
 
 
+class InheritanceEdgeStyle(EdgeStyle):
+    """EdgeStyle representing inheritance."""
+
+    nx_edge_color: str = 'grey'
+    nx_style: str = 'solid'
+    nx_arrows: bool = True
+    nx_arrowstyle: str = '-|>'
+    nx_arrowsize: int = 15
+    gv_arrowhead: str = 'empty'
+    gv_color: str = 'black'
+    gv_style: str = 'solid'
+
+
 def edge_style_factory(style_tag, styles={}, **kwargs):
     """
     Get the appropriate EdgeStyle for networkx plotting.
@@ -307,6 +320,8 @@ def edge_style_factory(style_tag, styles={}, **kwargs):
         style_class = ContainmentEdgeStyle
     elif style_tag == 'connection':
         style_class = ConnectionEdgeStyle
+    elif style_tag == 'inheritance':
+        style_class = InheritanceEdgeStyle
     else:
         raise Exception("Invalid edge style: "+str(style_tag))
     return style_class(styles=styles, **kwargs)
@@ -383,7 +398,8 @@ class NodeStyle(BaseStyle):
         Digraph, Graph = gv_import_check()
         dot = Digraph()
         dot.node('0', label=self.__class__.__name__, **self.gv_kwargs())
-        display(SVG(dot._repr_image_svg_xml()))
+        if disp:
+            display(SVG(dot._repr_image_svg_xml()))
         gv_plot_ending(dot, disp=disp, saveas=saveas)
         return dot
 
@@ -556,6 +572,8 @@ def node_style_factory(style_tag, styles={}, **kwargs):
         node_style = MethodNodeStyle
     elif style_tag in ['dict', 'flexible']:
         node_style = OtherNodeStyle
+    elif style_tag in ['class', 'Class']:
+        node_style = OtherNodeStyle
     else:
         raise Exception("Invalid node style: "+str(style_tag))
     return node_style(styles=styles, **kwargs)

{fmdtools-2.0.3 → fmdtools-2.0.4}/fmdtools/define/base.py

@@ -244,11 +244,17 @@ def get_code_attrs(obj):
         code = "\n".join(code.split("\n        "))
         code = remove_para(code)
     else:
-        source = inspect.getsource(obj.__class__)
+        if inspect.isclass(obj):
+            objcl = obj
+        else:
+            objcl = obj.__class__
+        source = inspect.getsource(objcl)
         if hasattr(obj, 'get_code'):
             code = obj.get_code(source)
         else:
             code = ""
+        if str(obj.__doc__) not in source or 'fmdtools.' in objcl.__module__:
+            docs = ""
     return {'source': source, 'code': code, 'docs': docs}
 
 
@@ -259,6 +265,7 @@ def remove_para(source):
     else:
         return source
 
+
 def get_methods(obj):
     """Get methods from the given object."""
     methods = {at[0]: at[1] for at in inspect.getmembers(obj)
@@ -282,6 +289,8 @@ def get_obj_name(obj, role='', basename=''):
     name : str
         Name of the object.
     """
+    if inspect.isclass(obj):
+        return obj.__module__ + '.' + obj.__name__
     if hasattr(obj, 'get_full_name'):
         return obj.get_full_name()
     elif inspect.ismethod(obj):
@@ -301,3 +310,24 @@ def get_memory(role):
     else:
         mem = sys.getsizeof(role)
     return mem
+
+
+def get_inheritance(obj):
+    """
+    Get the base class(es) that the object inherits from.
+
+    Parameters
+    ----------
+    obj : object
+        Object to get base of.
+
+    Returns
+    -------
+    classes : tuple
+        Tuple of classes that are the base of the object.
+    """
+    if inspect.isclass(obj):
+        return tuple([b for b in obj.__bases__
+                      if b is not object and b is not dataobject])
+    else:
+        return (obj.__class__, )

{fmdtools-2.0.3 → fmdtools-2.0.4}/fmdtools/define/block/base.py

@@ -37,30 +37,31 @@ class SimParam(Parameter, readonly=True):
     """
     Class defining Simulation parameters.
 
-    Has fields:
-        phases : tuple
-            phases (('name', start, end)...) that the simulation progresses through
-        start_time : float
-            Start time of the simulation.
-        end_time : float
-            End time of the simulation.
-        track_times : tuple
-            Defines what times to include in the history.
-            Options are:
-            - ('all',)--all simulated times
-            - ('interval', n)--includes every nth time in the history
-            - ('times', [t1, ... tn])--only includes times defined in the
-              vector [t1 ... tn]
-        dt : float
-            time-step used in the simulation. default is 1.0
-        units : str
-            time-units. default is hours`
-        end_condition : str
-            Name of indicator method to use to end the simulation. If not provided (''),
-            the simulation ends at the final time. Default is ''
-        use_local : bool
-            Whether to use locally-defined time-steps in functions (if any).
-            Default is True.
+    Parameters
+    ----------
+    phases : tuple
+        phases (('name', start, end)...) that the simulation progresses through
+    start_time : float
+        Start time of the simulation.
+    end_time : float
+        End time of the simulation.
+    track_times : tuple
+        Defines what times to include in the history.
+        Options are:
+        - ('all',)--all simulated times
+        - ('interval', n)--includes every nth time in the history
+        - ('times', [t1, ... tn])--only includes times defined in the
+          vector [t1 ... tn]
+    dt : float
+        time-step used in the simulation. default is 1.0
+    units : str
+        time-units. default is hours`
+    end_condition : str
+        Name of indicator method to use to end the simulation. If not provided (''),
+        the simulation ends at the final time. Default is ''
+    use_local : bool
+        Whether to use locally-defined time-steps in functions (if any).
+        Default is True.
     """
 
     rolename = "sp"

{fmdtools-2.0.3 → fmdtools-2.0.4}/fmdtools/define/container/parameter.py

@@ -27,8 +27,9 @@ import numpy as np
 
 class Parameter(BaseContainer, readonly=True):
     """
-    The Parameter class defines model/function/flow values which are immutable,
-    that is, the same from model instantiation through a simulation. Parameters
+    The Parameter class defines model/function/flow values which are immutable.
+
+    That is, the same from model instantiation through a simulation. Parameters
     inherit from recordclass, giving them a low memory footprint, and use type
     hints and ranges to ensure parameter values are valid. e.g.,: