fmdtools 2.5.1__tar.gz → 2.5.2__tar.gz

{fmdtools-2.5.1 → fmdtools-2.5.2}/LICENSE

@@ -1,4 +1,4 @@
-fmdtools version 2.5.1
+fmdtools version 2.5.2
 ---------------------------
                                  Apache License
                            Version 2.0, January 2004

{fmdtools-2.5.1/fmdtools.egg-info → fmdtools-2.5.2}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: fmdtools
-Version: 2.5.1
+Version: 2.5.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.5.1
+License: fmdtools version 2.5.2
         ---------------------------
                                          Apache License
                                    Version 2.0, January 2004
@@ -394,7 +394,7 @@ More guidance on development installations is provided in [How to Contribute](ht
 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.5.1
+   git checkout v2.5.2
 ```
 
 
@@ -499,7 +499,10 @@ Once fmdtools is installed, use the following to get acquainted with how to use
 Decent (but **very imperfect**) results can be achieved using LLMs for model development using the prompt:
 
 ```prompt
-You are an experienced software engineer learning a new Python library for the first time. Make an fmdtools simulation of racecar using the latest syntax from `https://github.com/nasa/fmdtools/tree/v2.5.1` for all modeling (`fmdtools.define`), simulation (`fmdtools.sim`), and analysis (`fmdtools.analyze`) classes. The output should be a bare bones but well-commented .py file with simple behaviors for each class and a small script at the bottom leveraging the built-in capabilities in the `fmdtools.analyze` package instead of directly using external libraries like matplotlib. As you are going, explain the structure of each class, the usage of each function call and how they each leverage the correct fmdtools v2.5.1 syntax.
+You are an experienced software engineer learning a new Python library for the first time.
+Make an fmdtools simulation of a <enter your system here> using the latest syntax from `https://github.com/nasa/fmdtools/tree/v2.5.1` for all modeling (`fmdtools.define`), simulation (`fmdtools.sim`), and analysis (`fmdtools.analyze`) classes.
+The output should be a bare bones but well-commented .py file with simple behaviors for each class and a small script at the bottom leveraging the built-in capabilities in the `fmdtools.analyze` package instead of directly using external libraries like matplotlib.
+As you are going, explain the structure of each class, the usage of each function call and how they each leverage the correct fmdtools v2.5.1 syntax.
 ```
 
 The important aspects of this prompt are specifying the URL and version--otherwise the LLM is likely to hallucinate usage or recall an earlier version of fmdtools. Do not expect perfect output from this--you may have to spend some time identifying the problems so they can be fixed!
@@ -545,8 +548,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.5.1},
-  date = {2026-9-22},
+  version = {2.5.2},
+  date = {2026-9-28},
 }
 ```
 

{fmdtools-2.5.1 → fmdtools-2.5.2}/README.md

@@ -123,7 +123,7 @@ More guidance on development installations is provided in [How to Contribute](ht
 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.5.1
+   git checkout v2.5.2
 ```
 
 
@@ -228,7 +228,10 @@ Once fmdtools is installed, use the following to get acquainted with how to use
 Decent (but **very imperfect**) results can be achieved using LLMs for model development using the prompt:
 
 ```prompt
-You are an experienced software engineer learning a new Python library for the first time. Make an fmdtools simulation of racecar using the latest syntax from `https://github.com/nasa/fmdtools/tree/v2.5.1` for all modeling (`fmdtools.define`), simulation (`fmdtools.sim`), and analysis (`fmdtools.analyze`) classes. The output should be a bare bones but well-commented .py file with simple behaviors for each class and a small script at the bottom leveraging the built-in capabilities in the `fmdtools.analyze` package instead of directly using external libraries like matplotlib. As you are going, explain the structure of each class, the usage of each function call and how they each leverage the correct fmdtools v2.5.1 syntax.
+You are an experienced software engineer learning a new Python library for the first time.
+Make an fmdtools simulation of a <enter your system here> using the latest syntax from `https://github.com/nasa/fmdtools/tree/v2.5.1` for all modeling (`fmdtools.define`), simulation (`fmdtools.sim`), and analysis (`fmdtools.analyze`) classes.
+The output should be a bare bones but well-commented .py file with simple behaviors for each class and a small script at the bottom leveraging the built-in capabilities in the `fmdtools.analyze` package instead of directly using external libraries like matplotlib.
+As you are going, explain the structure of each class, the usage of each function call and how they each leverage the correct fmdtools v2.5.1 syntax.
 ```
 
 The important aspects of this prompt are specifying the URL and version--otherwise the LLM is likely to hallucinate usage or recall an earlier version of fmdtools. Do not expect perfect output from this--you may have to spend some time identifying the problems so they can be fixed!
@@ -274,8 +277,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.5.1},
-  date = {2026-9-22},
+  version = {2.5.2},
+  date = {2026-9-28},
 }
 ```
 

{fmdtools-2.5.1 → fmdtools-2.5.2}/examples/multirotor_drone/test_multirotor.py

@@ -150,7 +150,7 @@ class DroneDisturbanceTest(unittest.TestCase):
         amt = self.mdl.fxns['store_ee'].ca.comps['s1p1'].p.amt
         soc_expected = soc_set - 100/amt
         soc_res = self.edp.f2(soc_set)
-        self.assertEqual(soc_expected, soc_res)
+        self.assertAlmostEqual(soc_expected, soc_res)
 
         # make sure the disturbance wasn't set permanently
         soc_later = self.edp.f1(soc_set)

{fmdtools-2.5.1 → fmdtools-2.5.2}/examples/navigating_rover/test_rover.py

@@ -18,6 +18,7 @@ specific language governing permissions and limitations under the License.
 from fmdtools_tests.common import CommonTests
 from fmdtools_examples.navigating_rover.script_search_rover import line_dist, line_dist_faster
 import unittest
+import numpy as np
 
 
 class RoverTests(unittest.TestCase, CommonTests):
@@ -29,9 +30,9 @@ class RoverTests(unittest.TestCase, CommonTests):
             dist_int, enddist_int, endpt_int = line_dist_faster(testvalue)
             dist, enddist, endpt = line_dist(testvalue)
 
-            self.assertEqual(dist, dist_int)
-            self.assertEqual(enddist, enddist_int)
-            self.assertEqual(endpt, endpt_int)
+            self.assertTrue(np.isclose(dist, dist_int))
+            self.assertTrue(np.isclose(enddist, enddist_int))
+            self.assertTrue(np.isclose(endpt, endpt_int).all())
 
 
 if __name__ == '__main__':

{fmdtools-2.5.1 → fmdtools-2.5.2}/examples/water_pump/model_main.py

@@ -632,14 +632,14 @@ def script_sample_faults(track='all', **kwargs):
 
     gh = mdlhists.get_comp_groups('flows.ee_1.s.current')
 
-    results, mdlhists_staged = propagate.fault_sample(mdl, faultapp,
-                                                      staged=True, track='all')
+    # results, mdlhists_staged = propagate.fault_sample(mdl, faultapp,
+    #                                                   staged=True, track='all')
 
-    tab = an.tabulate.result_summary_fmea(
-            results, mdlhists, *mdl.fxns, *mdl.flows)
+    # tab = an.tabulate.result_summary_fmea(
+    #         results, mdlhists, *mdl.fxns, *mdl.flows)
 
     h = mdlhists.get_expected(app=faultapp, with_nominal=True)
-    ec = results.get_expected()
+    # ec = results.get_expected()
 
     # degsumm = h.get_summary(*mdl.fxns, *mdl.flows)
 
@@ -658,7 +658,7 @@ def script_sample_faults(track='all', **kwargs):
     fmea = an.tabulate.FMEA(results, faultapp)
     fmea.as_table()
     fmea.sort_by_metric("expected_cost")
-    fmea.as_plot("expected_cost", color_factor="function")
+    fmea.as_plot("expected_cost", color_factor="obj")
 
     # test cases for multiplot legend/axis sharing
     mdlhists.plot_line("flows.ee_1.s.current", "flows.sig_1.s.power",
@@ -679,6 +679,8 @@ if __name__ == "__main__":
     mdl = Pump()
     res, hist = propagate.nominal(mdl, to_return = {'graph': FunctionArchitectureGraph})
 
+    # script_sample_faults()
+
     """
     endfaults, mdlhist = propagate.one_fault(mdl, 'export_water', 'block',
                                              time=10, to_return='faults')

{fmdtools-2.5.1 → fmdtools-2.5.2/fmdtools.egg-info}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: fmdtools
-Version: 2.5.1
+Version: 2.5.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.5.1
+License: fmdtools version 2.5.2
         ---------------------------
                                          Apache License
                                    Version 2.0, January 2004
@@ -394,7 +394,7 @@ More guidance on development installations is provided in [How to Contribute](ht
 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.5.1
+   git checkout v2.5.2
 ```
 
 
@@ -499,7 +499,10 @@ Once fmdtools is installed, use the following to get acquainted with how to use
 Decent (but **very imperfect**) results can be achieved using LLMs for model development using the prompt:
 
 ```prompt
-You are an experienced software engineer learning a new Python library for the first time. Make an fmdtools simulation of racecar using the latest syntax from `https://github.com/nasa/fmdtools/tree/v2.5.1` for all modeling (`fmdtools.define`), simulation (`fmdtools.sim`), and analysis (`fmdtools.analyze`) classes. The output should be a bare bones but well-commented .py file with simple behaviors for each class and a small script at the bottom leveraging the built-in capabilities in the `fmdtools.analyze` package instead of directly using external libraries like matplotlib. As you are going, explain the structure of each class, the usage of each function call and how they each leverage the correct fmdtools v2.5.1 syntax.
+You are an experienced software engineer learning a new Python library for the first time.
+Make an fmdtools simulation of a <enter your system here> using the latest syntax from `https://github.com/nasa/fmdtools/tree/v2.5.1` for all modeling (`fmdtools.define`), simulation (`fmdtools.sim`), and analysis (`fmdtools.analyze`) classes.
+The output should be a bare bones but well-commented .py file with simple behaviors for each class and a small script at the bottom leveraging the built-in capabilities in the `fmdtools.analyze` package instead of directly using external libraries like matplotlib.
+As you are going, explain the structure of each class, the usage of each function call and how they each leverage the correct fmdtools v2.5.1 syntax.
 ```
 
 The important aspects of this prompt are specifying the URL and version--otherwise the LLM is likely to hallucinate usage or recall an earlier version of fmdtools. Do not expect perfect output from this--you may have to spend some time identifying the problems so they can be fixed!
@@ -545,8 +548,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.5.1},
-  date = {2026-9-22},
+  version = {2.5.2},
+  date = {2026-9-28},
 }
 ```
 

{fmdtools-2.5.1 → fmdtools-2.5.2}/fmdtools.egg-info/SOURCES.txt

@@ -127,8 +127,31 @@ src/fmdtools/sim/scenario.py
 src/fmdtools/sim/search.py
 tests/__init__.py
 tests/common.py
+tests/test_array_random_states.py
+tests/test_calc_metric_ci_constant_outputs.py
+tests/test_comparison_groups.py
+tests/test_confidence_history_clipping.py
+tests/test_error_history_plots.py
+tests/test_fault_sample_without_nominal.py
+tests/test_fault_time_without_traces.py
 tests/test_geom.py
 tests/test_graph.py
 tests/test_hierarchical.py
+tests/test_history_standard_deviation.py
+tests/test_join_phasemaps.py
+tests/test_joint_fault_weights.py
+tests/test_nested_nominal_groups.py
+tests/test_nesting_custom_separators.py
 tests/test_packages.py
-tests/test_pathplan.py
+tests/test_parameter_sample_seeds.py
+tests/test_parameter_subsampling_types.py
+tests/test_pathplan.py
+tests/test_phase_timestep.py
+tests/test_pruned_fault_times.py
+tests/test_result.py
+tests/test_sample.py
+tests/test_scenario.py
+tests/test_scenario_defaults.py
+tests/test_table_factor_indices.py
+tests/test_time.py
+tests/test_uniform_density.py

{fmdtools-2.5.1 → fmdtools-2.5.2}/pyproject.toml

@@ -18,7 +18,7 @@ classifiers = [
 description = "System resilience modelling, simulation, and assessment in Python"
 license = {file="LICENSE"}
 name = "fmdtools"
-version="2.5.1"
+version="2.5.2"
 readme = "README.md"
 requires-python = ">=3.12"
 

{fmdtools-2.5.1 → fmdtools-2.5.2}/src/fmdtools/__init__.py

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

{fmdtools-2.5.1 → fmdtools-2.5.2}/src/fmdtools/analyze/common.py

@@ -41,7 +41,7 @@ import matplotlib.pyplot as plt
 from matplotlib import rcParams
 import inspect
 from scipy.stats import bootstrap
-from fmdtools.define.base import filter_kwargs
+from fmdtools.define.base import filter_kwargs, round_float
 
 
 plt.rcParams['pdf.fonttype'] = 42
@@ -229,7 +229,8 @@ def metric_preamble(data, dtype=None, rates=None, r_dtype=None, r_norm=False):
 
 
 def calc_metric(data, method=np.average, args=(), axis=None, dtype=None,
-                rates=None, r_dtype=None, r_norm=False, **kwargs):
+                rates=None, r_dtype=None, r_norm=False, round_value=True,
+                res=1e-6, min_r=7, **kwargs):
     """
     Calculate a metric from data.
 
@@ -253,12 +254,18 @@ def calc_metric(data, method=np.average, args=(), axis=None, dtype=None,
         Datatype to preprocess the rates over. The default is None.
     r_norm : bool, optional
         Whether to normalize rates. The default is False.
+    round_value : bool, optional
+        Whether to round the value. Default is True.
+    res : float
+        Resolution to round to. Default is 1e-6.
+    min_r : int
+        Maximum number of digits to round to (see round_float).
     **kwargs : kwargs
-        Keyword arguments to method.
+        Keyword arguments to method (see round_float).
 
     Returns
     -------
-    metric: float
+    metric: np.float64/np.int64
         Metric calculated by method over data.
 
     Examples
@@ -266,7 +273,7 @@ def calc_metric(data, method=np.average, args=(), axis=None, dtype=None,
     >>> calc_metric([1,2,3]) # simple average
     np.float64(2.0)
     >>> calc_metric([1,2,3], rates=[0.1, 0.1, 0.0], method=np.sum) # weighted sum
-    np.float64(0.30000000000000004)
+    np.float64(0.3)
     >>> calc_metric([0, 20, 30], dtype=bool, rates=[0.1, 0.1, 0.1], method=np.sum) # rate of nonzero event
     np.float64(0.2)
     >>> calc_metric([0, 1, 2], "total")
@@ -276,11 +283,15 @@ def calc_metric(data, method=np.average, args=(), axis=None, dtype=None,
     """
     if isinstance(method, str):
         method = eval("calc_"+method)
-        return method(data, args=args, axis=axis, dtype=dtype, rates=rates,
+        metric = method(data, args=args, axis=axis, dtype=dtype, rates=rates,
                       r_dtype=r_dtype, r_norm=r_norm, **kwargs)
     else:
         vals = metric_preamble(data, dtype, rates, r_dtype, r_norm)
-        return method(vals, *args, **filter_kwargs(method, **kwargs, axis=axis))
+        metric = method(vals, *args, **filter_kwargs(method, **kwargs, axis=axis))
+    if round_value and (isinstance(metric, np.floating) or isinstance(metric, float)):
+        return round_float(metric, res=res, min_r=min_r)
+    else:
+        return metric
 
 
 def calc_metric_ci(data, method=np.average, return_anyway=False, interval=None,
@@ -325,15 +336,13 @@ def calc_metric_ci(data, method=np.average, return_anyway=False, interval=None,
         bs_kwar['confidence_level'] = interval*0.01
 
     vals = metric_preamble(data, **filter_kwargs(metric_preamble, **kwargs))
-    if len(np.shape(vals)) > 1:
-        val = vals[axis, 0]
-    else:
-        val = np.array(vals).flatten()[0]
+    val = np.take(vals, [0], axis=axis)
     if "weights" in kwargs and kwargs['weights'] is not None:
         raise Exception("Weights not able to be used w- bootstrap--use rates instead.")
     met_val = method(vals, axis=axis, **filter_kwargs(method, **kwargs))
     vals_vary = vals == val
-    if not np.all(vals_vary):
+    # Preserve the existing policy for globally identical data.
+    if not np.all(vals == vals.flat[0]):
         if np.any(np.all(vals_vary, axis=axis)):
             # use more robust/basic algorithm if some indices don't vary
             bs = bootstrap([vals], method, axis=axis, method="basic", **bs_kwar)
@@ -353,7 +362,7 @@ def calc_rate(data, rates=None, weights=None, **kwargs):
     Examples
     --------
     >>> calc_rate([0, 10, 0]) # defaults to equal rate
-    np.float64(0.3333333333333333)
+    np.float64(0.333333)
     >>> calc_rate([0, 10, 100], [0.1, 0.1, 0.1]) # provided rates
     np.float64(0.2)
     """
@@ -370,7 +379,7 @@ def calc_percent(data, weights=None, rates=None, **kwargs):
     Examples
     --------
     >>> calc_percent([0, 10, 0])
-    np.float64(0.3333333333333333)
+    np.float64(0.333333)
     """
     return calc_metric(data, **{**kwargs, 'dtype': bool})
 
@@ -386,7 +395,7 @@ def calc_total(data, weights=None, **kwargs):
     >>> calc_total([0, 10, 100])
     np.int64(2)
     """
-    return calc_metric(data, **{**kwargs, 'method': np.sum, 'dtype': bool})
+    return np.int64(calc_metric(data, **{**kwargs, 'method': np.sum, 'dtype': bool}))
 
 
 def calc_expected(data, rates=None, weights=None, **kwargs):
@@ -519,8 +528,8 @@ def plot_err_hist(err_hist, ax=None, fig=None, figsize=(6, 4), boundtype='fill',
     fig : mpl figure
     ax :mpl, axis
     """
-    fig, ax = setup_plot(fig, ax, figsize)
-    ax.plot(err_hist['stat'], **kwargs)
+    fig, ax = setup_plot(fig=fig, ax=ax, figsize=figsize)
+    ax.plot(err_hist[time], err_hist['stat'], **kwargs)
     if boundtype == 'fill':
         col = ax.lines[-1].get_color()
         ax.fill_between(err_hist[time], err_hist['low'], err_hist['high'],
@@ -582,7 +591,7 @@ def plot_err_lines(times, lows, highs, ax=None, fig=None, figsize=(6, 4), **kwar
     **kwargs : kwargs
         kwargs for the line
     """
-    fig, ax = setup_plot(ax, fig, figsize)
+    fig, ax = setup_plot(fig=fig, ax=ax, figsize=figsize)
     ax.plot(times, highs, **kwargs)
     ax.plot(times, lows, **kwargs)
     return fig, ax

{fmdtools-2.5.1 → fmdtools-2.5.2}/src/fmdtools/analyze/history.py

@@ -360,6 +360,9 @@ class History(Result):
         """
         Get the time a fault is present in the system.
 
+        Only recorded fault traces are considered. Without recorded faults,
+        returns zero for ``total`` and ``nan`` for the position metrics.
+
         Parameters
         ----------
         metric : 'earliest','latest','total', 'times', optional
@@ -373,6 +376,8 @@ class History(Result):
 
         Examples
         --------
+        >>> History(time=[0, 1, 2]).get_fault_time()
+        nan
         >>> History({'m.faults.fault1': [False, False, False]}).get_fault_time()
         nan
         >>> History({'m.faults.fault1': [False, False, True]}).get_fault_time()
@@ -383,7 +388,7 @@ class History(Result):
         if metric == 'total':
             return np.sum(all_faults_hist >= 1)
         else:
-            times = np.where(all_faults_hist >= 1)[0]
+            times = np.where(np.atleast_1d(all_faults_hist) >= 1)[0]
             if times.size == 0:
                 return np.nan
             elif metric == 'times':
@@ -809,6 +814,8 @@ class History(Result):
         """
         Get aggregated err_hist of means surrounded by std deviation.
 
+        Calculate the spread across histories separately at each time sample.
+
         Parameters
         ----------
         value : str
@@ -829,7 +836,7 @@ class History(Result):
         hist = History()
         hist[time] = self.get_metric(time, axis=0)
         hist['stat'] = self.get_metric(value, np.mean, axis=0)
-        std_dev = self.get_metric(value, np.std)
+        std_dev = self.get_metric(value, np.std, axis=0)
         hist['high'] = hist['stat']+std_dev/2
         hist['low'] = hist['stat']-std_dev/2
         return hist
@@ -851,7 +858,8 @@ class History(Result):
         ci : float
             Fraction for confidence interval. Default is 0.95.
         max_ind : str/int
-            Max index of time to clip to. Default is 'max'.
+            Exclusive slice endpoint for both timestamps and values. Default is
+            'max', which uses the shortest history length.
 
         Returns
         -------
@@ -874,6 +882,7 @@ class History(Result):
         hist[time] = self.get_metric(time, axis=0)
         if max_ind == 'max':
             max_ind = min([len(h) for h in self.values()])
+        hist[time] = hist[time][:max_ind]
         vals = np.array([*self.get_values(value).values()])[:, :max_ind]
         boot_stats = calc_metric_ci(vals, confidence_level=ci, axis=0, **kwargs)
         hist['stat'] = boot_stats[0]

{fmdtools-2.5.1 → fmdtools-2.5.2}/src/fmdtools/analyze/phases.py

@@ -80,7 +80,7 @@ class PhaseMap(object):
     def __repr__(self):
         return 'PhaseMap(' + str(self.phases) + ', ' + str(self.modephases) + ')'
 
-    def find_phase(self, time, dt=1.0):
+    def find_phase(self, time, dt=None):
         """
         Find the phase that a time occurs in.
 
@@ -88,12 +88,17 @@ class PhaseMap(object):
         ----------
         time : float
             Occurence time.
+        dt : float, optional
+            Width of the final sample in each phase. Defaults to this map's dt.
+            An explicit value overrides the configured timestep for this lookup.
 
         Returns
         -------
         phase : str
             Name of the phase time occurs in.
         """
+        if dt is None:
+            dt = self.dt
         for phase, times in self.phases.items():
             if times[0] <= time < times[1]+dt:
                 return phase
@@ -677,8 +682,7 @@ def join_phasemaps(*phasemaps):
     joint_phases = {}
     all_combos = [*itertools.product(*[phasemap.phases for phasemap in phasemaps])]
     for combo in all_combos:
-        phases = {c: phasemaps[i].phases[c] for i, c in enumerate(combo)}
-        intervals = [i for i in phases.values()]
+        intervals = [phasemaps[i].phases[c] for i, c in enumerate(combo)]
         joined_interval = find_interval_overlap(*intervals)
         if joined_interval:
             joint_phases[combo] = joined_interval

{fmdtools-2.5.1 → fmdtools-2.5.2}/src/fmdtools/analyze/result.py

@@ -41,6 +41,7 @@ specific language governing permissions and limitations under the License.
 """
 
 from fmdtools.define.base import t_key, nest_dict, is_numeric, is_bool, is_iter
+from fmdtools.define.base import round_float
 from fmdtools.analyze.common import to_include_keys, create_indiv_filename
 from fmdtools.analyze.common import calc_metric, calc_metric_ci, join_key
 from fmdtools.analyze.common import get_sub_include, unpack_plot_values
@@ -551,7 +552,9 @@ class Result(UserDict):
         *values : str
             Values to get (e.g. `fxns.fxnname.s.val`)
         **groups : list
-            Sets of scenarios to group (e.g. set_1=['scen1', 'scen2'...])
+            Sets of scenarios to group (e.g. set_1=['scen1', 'scen2'...]).
+            Scenario names match at dot-separated path boundaries; selecting a
+            parent scenario also includes its nested scenarios.
 
         Returns
         -------
@@ -569,7 +572,7 @@ class Result(UserDict):
             elif isinstance(scens, str):
                 scens = [scens]
             k_vs = [k for k in self.keys() for scen in scens for v in values
-                    if k.startswith(scen) and k.endswith(v) and '.t.' not in k]
+                    if k.startswith(scen+'.') and k.endswith(v) and '.t.' not in k]
             if len(k_vs) > 0 and (group not in group_hist):
                 group_hist[group] = self.__class__()
             for k in k_vs:
@@ -587,22 +590,26 @@ class Result(UserDict):
 
     def get_default_comp_groups(self):
         """
-        Get a dict of nominal and faulty scenario keys from the Result.
+        Get nominal and faulty keys for single or nested scenario samples.
+
+        Nested samples retain their parent prefix (e.g., ``sample.nominal``).
+        Only a scenario named exactly ``nominal`` belongs to the nominal group.
 
         Returns
         -------
         comp_groups : dict
             Dict with structure {'nominal': [list of nominal scenarios], 'faulty': [list of faulty scenarios]}.
-            If no nominal or faulty, returns an empty dict {}.
+            If no nominal scenario is found, returns {'default': 'default'}.
         """
-        nest = self.nest(1)
-        nest2 = self.nest(2)
+        flat = self.flatten()
+        nest = flat.nest(1)
+        nest2 = flat.nest(1, skip=1)
         if 'nominal' in nest.keys():
             comp_groups = {'nominal': 'nominal',
                            'faulty': [f for f in nest.keys() if f != 'nominal']}
-        elif any(['nominal' in k for k in nest2.keys()]):
-            comp_groups = {'nominal': [f for f in nest2.keys() if 'nominal' not in f],
-                           'faulty': [f for f in nest2.keys() if 'nominal' not in f]}
+        elif any(k.endswith('.nominal') for k in nest2):
+            comp_groups = {'nominal': [f for f in nest2 if f.endswith('.nominal')],
+                           'faulty': [f for f in nest2 if not f.endswith('.nominal')]}
         else:
             comp_groups = {'default': 'default'}
         return comp_groups
@@ -781,7 +788,8 @@ class Result(UserDict):
         else:
             return tab.loc[:, metrics]
 
-    def get_expected(self, app=[], with_nominal=False, difference_from_nominal=False):
+    def get_expected(self, app=[], with_nominal=False, difference_from_nominal=False,
+                     round_value=True, res=1e-6, **kwargs):
         """
         Take the expectation of numeric metrics in the result over given scenarios.
 
@@ -795,6 +803,8 @@ class Result(UserDict):
         difference_from_nominal : bool, optional
             Whether to calculated the difference of the expectation from nominal.
             The default is False.
+        **kwargs
+            kwargs to round_float
 
         Returns
         -------
@@ -808,21 +818,25 @@ class Result(UserDict):
         newhists = {k: hist for k, hist in mh.items()
                     if not ('nominal' in k and not (with_nominal))}
         if app:
-            weights = [w.rate for w in app.scenarios()]
+            scenario_rates = {scen.name: scen.rate for scen in app.scenarios()}
             if with_nominal:
-                weights.append(1)
+                scenario_rates['nominal'] = 1
+            weights = [scenario_rates[name] for name in newhists]
         else:
             weights = [1 for k in newhists]
 
         expres = self.__class__()
         for k in nomhist.keys():
             if difference_from_nominal:
-                expres[k] = np.average([nomhist[k]-hist[k]
-                                        for hist in newhists.values()],
-                                       axis=0, weights=weights)
+                value = np.average([nomhist[k]-hist[k] for hist in newhists.values()],
+                                    axis=0, weights=weights)
+            else:
+                value = np.average([hist[k] for hist in newhists.values()],
+                                   axis=0, weights=weights)
+            if round_value:
+                expres[k] = round_float(value, res=res, **kwargs)
             else:
-                expres[k] = np.average([hist[k] for hist in newhists.values()],
-                                       axis=0, weights=weights)
+                expres[k] = value
         return expres
 
     def get_metric(self, value, method=np.average, rates=None, weights=None, prefix="",
@@ -856,7 +870,7 @@ class Result(UserDict):
         >>> r.get_metric("b", method="expected", rates="a")
         np.float64(0.005)
         >>> r.get_metric("b", "expected", rates={"t1": 1, "t2": 2})
-        np.float64(0.21000000000000002)
+        np.float64(0.21)
         """
         vals, rates, weights = self.get_vals(value, prefix=prefix,
                                              rates=rates, weights=weights)

{fmdtools-2.5.1 → fmdtools-2.5.2}/src/fmdtools/analyze/tabulate.py

@@ -179,13 +179,15 @@ class BaseTab(UserDict):
         Parameters
         ----------
         factor : str/int
-            Name or index of factor to sort by.
+            Factor name or zero-based tuple index to sort by. Negative indices
+            follow the usual Python indexing convention.
         reverse : bool, optional
             Whether to sort in descending order. The default is False.
         """
         metric = [*self.keys()][0]
         keys = [k for k in self[metric].keys()]
 
+        value = factor
         if hasattr(self, 'factors') and isinstance(factor, str):
             value = self.factors.index(factor)
 

{fmdtools-2.5.1 → fmdtools-2.5.2}/src/fmdtools/define/architecture/geom.py

@@ -147,7 +147,7 @@ class GeomArchitecture(Architecture):
             if not isinstance(gclass, baseclass):
                 raise Exception("gclass "+gclass+" not a "+baseclass.__name__)
 
-    def add_geom(self, name, pclass=GeomJSON, **kwargs):
+    def add_geom(self, name, gclass=GeomJSON, **kwargs):
         """
         Add/instantiate an individual geom to the architecture.
 
@@ -158,13 +158,13 @@ class GeomArchitecture(Architecture):
         ----------
         name : str
             Name for the geom.
-        pclass : BaseGeom, optional
+        gclass : BaseGeom, optional
             Class to instantiate. The default is GeomJSON.
         **kwargs : kwargs
             Keyword arguments to the class.
         """
-        self.check_geom_class(pclass, BaseGeom)
-        self.add_flex_role_obj("geoms", name, objclass=pclass, **kwargs)
+        self.check_geom_class(gclass, BaseGeom)
+        self.add_flex_role_obj("geoms", name, objclass=gclass, **kwargs)
 
     def all_at(self, *pt):
         """