fmdtools 2.1.2__tar.gz → 2.1.3__tar.gz

{fmdtools-2.1.2 → fmdtools-2.1.3}/LICENSE

@@ -1,4 +1,4 @@
-fmdtools version 2.1.2
+fmdtools version 2.1.3
 ---------------------------
                                  Apache License
                            Version 2.0, January 2004

{fmdtools-2.1.2 → fmdtools-2.1.3}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: fmdtools
-Version: 2.1.2
+Version: 2.1.3
 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.1.2
+License: fmdtools version 2.1.3
         ---------------------------
                                          Apache License
                                    Version 2.0, January 2004
@@ -367,7 +367,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.1.2
+   git checkout v2.1.3
 ```
 
 
@@ -505,8 +505,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.1.2},
-  date = {2025-5-19},
+  version = {2.1.3},
+  date = {2025-6-6},
 }
 ```
 

{fmdtools-2.1.2 → fmdtools-2.1.3}/README.md

@@ -106,7 +106,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.1.2
+   git checkout v2.1.3
 ```
 
 
@@ -244,8 +244,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.1.2},
-  date = {2025-5-19},
+  version = {2.1.3},
+  date = {2025-6-6},
 }
 ```
 

{fmdtools-2.1.2 → fmdtools-2.1.3}/examples/rover/rover_model.py

@@ -227,6 +227,7 @@ class DestState(State):
 class Dest(GeomPoint):
     """Start/end/point."""
 
+    __slots__ = ()
     container_p = DestParam
     container_s = DestState
 
@@ -252,9 +253,11 @@ class GroundGeomArch(GeomArchitecture):
 
 
 class GroundState(State):
-    """state defining if rover is in bound"""
+    """State defining if rover is in bounds."""
+
     in_bound: bool = True
 
+
 class Ground(Environment):
     """Ground environment of the rover."""
 
@@ -272,7 +275,8 @@ class Ground(Environment):
 
     def end_dist(self, pos_state):
         """Calculate minimum distance between the end point and the rover."""
-        return self.ga.points['end'].on.distance(Point(pos_state.get("x", "y")))
+        on_shape = self.ga.points['end'].get_shape('on')
+        return on_shape.distance(Point(pos_state.get("x", "y")))
 
     def max_line_dist(self, pos_hist):
         """Calculate the maximum distance the rover has deviated from its path."""
@@ -280,7 +284,7 @@ class Ground(Environment):
         yhist = pos_hist.y
         max_dist = 0.0
         for i, x in enumerate(xhist):
-            dist = self.ga.lines['line'].shape.distance(Point(x, yhist[i]))
+            dist = self.ga.lines['line'].get_shape().distance(Point(x, yhist[i]))
             if dist > max_dist:
                 max_dist = dist
         return max_dist
@@ -289,6 +293,7 @@ class Ground(Environment):
 class PathLine(GeomLine):
     """Rover Line."""
 
+    __slots__ = ()
     container_p = PathParam
 
 

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/__init__.py

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

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/analyze/history.py

@@ -268,7 +268,7 @@ class History(Result):
                             raise Exception(obj_str + "Value too large to represent: "
                                             + att + "=" + str(val)) from e
 
-    def cut(self, end_ind=None, start_ind=None, newcopy=False):
+    def cut(self, end_ind=None, start_ind=None, newcopy=False, reshape_to=None):
         """
         Cut the history to a given index.
 
@@ -283,6 +283,9 @@ class History(Result):
         newcopy: bool, optional
             Tells whether to creat a new history variable with the information what was
             cut or cut the original history variable. Default is False.
+        reshape_to: int, optional
+            Size of array to cut from, if different from current size. Default is None,
+            which does not reshape the array.
 
         Examples
         --------
@@ -306,15 +309,20 @@ class History(Result):
             hist = self
         for name, att in hist.items():
             if isinstance(att, History):
-                hist[name] = hist[name].cut(end_ind, start_ind, newcopy=False)
+                hist[name] = hist[name].cut(end_ind, start_ind,
+                                            newcopy=False, reshape_to=reshape_to)
             else:
                 try:
+                    if reshape_to and reshape_to != att.shape[0]:
+                        new_shape = tuple([reshape_to, *att.shape[1:]])
+                        att = np.resize(att, new_shape)
                     if end_ind is None:
-                        hist[name] = att[start_ind:]
-                    elif start_ind is None:
-                        hist[name] = att[:end_ind+1]
+                        ei = len(att)
                     else:
-                        hist[name] = att[start_ind:end_ind+1]
+                        ei = end_ind+1
+                    if start_ind is None:
+                        start_ind = 0
+                    hist[name] = att[start_ind:ei]
                 except TypeError as e:
                     raise Exception("Invalid history for name " + name +
                                     " in history "+str(hist.data)) from e

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/analyze/result.py

@@ -40,7 +40,7 @@ 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 t_key, nest_dict, is_numeric, is_bool, nan_to_x
+from fmdtools.define.base import t_key, nest_dict, is_numeric, is_bool
 from fmdtools.analyze.common import to_include_keys
 from fmdtools.analyze.common import calc_metric, calc_metric_ci, join_key
 from fmdtools.analyze.common import get_sub_include, unpack_plot_values

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/define/architecture/base.py

@@ -167,6 +167,8 @@ class Architecture(Simulable):
         # sync rands, if present
         if hasattr(self, 'r') and hasattr(objclass, "container_r"):
             kwargs = {**{'r': {"seed": self.r.seed}}, **kwargs}
+        if hasattr(objclass, "container_sp"):
+            kwargs = {**{'sp': self.sp.asdict()}, **kwargs}
         obj = init_obj(name=name, objclass=objclass, track=track,
                        as_copy=as_copy, root=self.get_full_name()+"."+flex_role,
                        **kwargs)
@@ -241,14 +243,10 @@ class Architecture(Simulable):
             Flows, dicts for non-default values to p, s, etc.
         """
         flows = self.get_flows(*flownames, all_if_empty=False)
-        fkwargs = {**{'sp': self.sp.asdict()}, **kwargs}
         if not self.sp.use_local:
-            fkwargs = {**{'t': {'dt': self.sp.dt}}, **fkwargs}
+            kwargs = {**{'t': {'dt': self.sp.dt}}, **kwargs}
 
-        self.add_flex_role_obj(flex_role, name, objclass=simclass, flows=flows, **fkwargs)
-
-        # add modes to overall mode dict
-        sim = self.get_flex_role_objs(flex_role)[name]
+        self.add_flex_role_obj(flex_role, name, objclass=simclass, flows=flows, **kwargs)
 
     def init_architecture(self, *args, **kwargs):
         """Use to initialize architecture."""

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/define/architecture/geom.py

@@ -51,13 +51,16 @@ class GeomArchitecture(Architecture):
 
     >>> ega = ExGeomArch()
     >>> ega.geoms()['ex_point'].s
-    ExGeomState(occupied=False)
+    ExGeomState(occupied=False, buffer_around=1.0)
     >>> ega.h
     points.ex_point.s.occupied:   array(101)
+    points.ex_point.s.buffer_around: array(101)
     lines.ex_line.s.occupied:     array(101)
+    lines.ex_line.s.buffer_around: array(101)
     polys.ex_poly.s.occupied:     array(101)
+    polys.ex_poly.s.buffer_around: array(101)
     >>> ega.return_mutables()
-    ((False,), (False,), (False,), (-0.1, 0, 0.0, 1))
+    ((False, 1.0), (False, 1.0), (False, 1.0), (-0.1, 0, 0.0, 1))
     """
 
     container_p = Parameter
@@ -153,11 +156,11 @@ class GeomArchitecture(Architecture):
         --------
         >>> exga = ExGeomArch()
         >>> exga.all_at(1.0, 1.0)
-        {'ex_point': ['shape', 'on'], 'ex_line': ['shape', 'on'], 'ex_poly': ['shape']}
+        {'ex_point': ['shape', 'on', 'around'], 'ex_line': ['shape', 'on', 'around'], 'ex_poly': ['shape', 'around']}
         >>> exga.all_at(0.0, 0.0)
-        {'ex_line': ['shape', 'on'], 'ex_poly': ['shape']}
+        {'ex_line': ['shape', 'on', 'around'], 'ex_poly': ['shape', 'around']}
         >>> exga.all_at(0.4, 0.3)
-        {'ex_point': ['on'], 'ex_line': ['on']}
+        {'ex_point': ['on', 'around'], 'ex_line': ['on', 'around'], 'ex_poly': ['around']}
         """
         all_at = {}
         for geomname, geom in self.geoms().items():
@@ -205,6 +208,31 @@ class GeomArchitecture(Architecture):
             fig, ax = self.geoms()[geomname].show(ax=ax, fig=fig, z=z, **local_kwargs)
         return fig, ax
 
+    def show_from(self, hist, t, **kwargs):
+        """
+        Show the GeomArch at the given time in the provided history.
+
+        Parameters
+        ----------
+        hist : History
+            History of states for the GeomArchitecture.
+        t : int
+            Time in the history to show the state of the GeomArchitecture at.
+        **kwargs : kwargs
+            Keyword arguments to GeomArchitecture.show().
+
+        Returns
+        -------
+        fig : figure
+            Matplotlib figure object
+        ax : axis
+            Corresponding matplotlib axis
+        """
+        for flex_role in self.flexible_roles:
+            for geomname, geom in self.get_flex_role_objs(flex_role).items():
+                geom.assign_from(hist.get(flex_role+"."+geomname), t)
+        return self.show(**kwargs)
+
 
 class ExGeomArch(GeomArchitecture):
     """Example Geometric Architecture for testing etc."""

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/define/container/base.py

@@ -22,6 +22,7 @@ from fmdtools.analyze.common import get_sub_include
 from fmdtools.analyze.history import History
 
 from recordclass import dataobject, astuple, asdict
+from collections import UserDict
 import copy
 import pickle
 import numpy as np
@@ -218,13 +219,13 @@ class BaseContainer(dataobject, mapping=True, iterable=True, copy_default=True):
             else:
                 # if kwarg states provided, assign keys to values
                 fielddict = {k: getattr(obj, v) for k, v in fielddict.items()}
-        elif isinstance(obj, dict):
+        elif isinstance(obj, dict) or isinstance(obj, UserDict):
             if not fielddict:
                 fielddict = {s: obj[s] for s in fields if s in obj}
             else:
                 fielddict = {k: obj[v] for k, v in fielddict.items() if v in obj}
         else:
-            raise Exception("Invalid type to assign from: "+obj.__class__)
+            raise Exception("Invalid type to assign from: "+str(obj.__class__))
         return fielddict
 
     def assign(self, obj, *fields, as_copy=True, **fielddict):

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/define/environment.py

@@ -19,6 +19,7 @@ specific language governing permissions and limitations under the License.
 
 from fmdtools.define.container.rand import Rand
 from fmdtools.define.flow.commsflow import CommsFlow
+from fmdtools.define.block.base import SimParam
 from fmdtools.define.object.coords import Coords, ExampleCoords
 from fmdtools.define.architecture.geom import GeomArchitecture, ExGeomArch
 
@@ -51,32 +52,37 @@ class Environment(CommsFlow):
     >>> env.create_hist([1.0])
     c.r.probdens:                   array(1)
     c.st:                           array(1)
-    ga.points.ex_point:             array(1)
-    ga.lines.ex_line:               array(1)
-    ga.polys.ex_poly:               array(1)
+    ga.points.ex_point.s.occupied:  array(1)
+    ga.points.ex_point.s.buffer_around: array(1)
+    ga.lines.ex_line.s.occupied:    array(1)
+    ga.lines.ex_line.s.buffer_around: array(1)
+    ga.polys.ex_poly.s.occupied:    array(1)
+    ga.polys.ex_poly.s.buffer_around: array(1)
     """
 
     slots = ["c", "r", "ga"]
     container_r = Rand
+    container_sp = SimParam
+    default_sp = {}
     coords_c = Coords
     arch_ga = GeomArchitecture
     roletypes = ['container', 'coords', 'arch']
     default_track = ('s', 'i', 'c', 'ga')
     all_possible = ('s', 'i', 'c', 'r', 'ga')
 
-    def __init__(self, name='', root='', glob=[], p={}, s={}, r={}, c={}, ga={},
+    def __init__(self, name='', root='', glob=[], p={}, s={}, r={}, sp={}, c={}, ga={},
                  track='default'):
-        super().__init__(name=name, root=root, glob=glob, p=p, s=s, track=track)
+        super().__init__(name=name, root=root, glob=glob, p=p, s=s, sp=sp, track=track)
         # NOTE: p and s also init here because if not, they are overritten
         # may need to change in the future
-        self.init_roletypes('container', "coords", "arch", r=r, p=p, s=s)
+        self.init_roletypes('container', "coords", "arch", r=r, p=p, s=s, sp=sp)
         if 'p' not in c and getattr(self.coords_c, 'container_p', None) == getattr(self, 'container_p', None):
             c = {**c, 'p': p}
         if 'p' not in ga and getattr(self.arch_ga, 'container_p', None) == getattr(self, 'container_p', None):
             ga = {**ga, 'p': p}
         r_kwargs = {'run_stochastic': self.r.run_stochastic, 'seed': self.r.seed}
         c = {**{'r': r_kwargs}, **c}
-        ga = {**{'r': r_kwargs}, **ga}
+        ga = {**{'r': r_kwargs, 'sp': self.sp}, **ga}
         self.init_roletypes('coords', 'arch', c=c, ga=ga)
 
     def base_type(self):
@@ -115,7 +121,8 @@ class Environment(CommsFlow):
         cop = super().copy(glob=glob, p=p, s=s)
         cop.r.assign(self.r)
         cop.c = self.c.copy()
-        cop.ga = self.ga.copy()
+        cop.sp = self.sp
+        cop.ga = self.ga.copy(sp=self.sp)
         if hasattr(self, 'h'):
             cop.h = self.h.copy()
         return cop

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/define/object/base.py

@@ -644,7 +644,10 @@ class BaseObject(object):
         hist : History
             A history of each recorded block property over the given timerange.
         """
-        if hasattr(self, 'h') and self.h and len([*self.h.values()][0]) == len(timerange):
+        if hasattr(self, 'h') and self.h:
+            len_timerange = len(timerange)
+            if len_timerange != len([*self.h.values()][0]):
+                self.h = self.h.cut(reshape_to=len_timerange)
             return self.h
         else:
             track = self.track

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools/define/object/geom.py

@@ -48,19 +48,18 @@ class Geom(BaseObject):
     """
     Base class for defining geometries.
 
-    Geometry objects are essentially wrappers around various shapely classes used to
+    Geometry objects are essentially interfaces for various shapely classes used to
     convey the spacial properties of a model.
 
-    ...
-
     Roles
     -----
     s : State
-        State defining mutable geom properties (e.g., allocation, color, etc)
+        State defining mutable properties (e.g., allocations, shapely class inputs)
     p : Param
-        Parameter defining immutable geom characteristics (e.g., shapely inputs, buffer)
+        Parameter defining immutable properties (e.g., shapely inputs, buffer)
     """
 
+    __slots__ = ('p', 's', 'shapenames', )
     container_s = State
     container_p = Parameter
     default_track = ['s']
@@ -70,22 +69,53 @@ class Geom(BaseObject):
 
     def __init__(self, *args, s={}, p={}, track='default', **kwargs):
         super().__init__(s=s, p=p, track=[], **kwargs)
-        self.shape = self.shapely_class(*self.p.as_args())
-        # set buffer shapes
-        self.init_role_dict("buffer")
-        for buffer, rad in self.buffers.items():
-            setattr(self, buffer, self.shape.buffer(rad))
+        self.shapenames = ['shape',
+                           *self.p.get_pref_attrs('buffer'),
+                           *self.s.get_pref_attrs('buffer')]
         self.init_track(track=track)
 
-    def at(self, pt, buffername='shape'):
+    def get_shape(self, shapename='shape'):
         """
-        Determine whether the point x, y is within the buffer 'buffername'.
+        Get the shapely object defining the class and buffers.
+
+        Parameters
+        ----------
+        shapename : str, optional
+            Name of the shape. The default is 'shape', which produces the base shape,
+            other names return the buffer shapes for that shape.
+
+        Returns
+        -------
+        shapely.geometry
+            Shapely object for the shape.
+        """
+        shape = self.shapely_class(*self.get_args())
+        if shapename == 'shape':
+            return shape
+        else:
+            argname = 'buffer_'+shapename
+            if hasattr(self.p, argname):
+                arg = self.p[argname]
+            elif hasattr(self.s, argname):
+                arg = self.s[argname]
+            else:
+                raise Exception(argname+" not in "+"Geom's "+str(self.s.__class__)
+                                + " or "+str(self.p.__class__))
+            return shape.buffer(arg)
+
+    def get_paramstates(self):
+        """Create dict of parameters and states."""
+        return {**self.p.asdict(), **self.s.asdict()}
+
+    def at(self, pt, shapename='shape'):
+        """
+        Determine whether the point x, y is within the buffer 'shapename'.
 
         Parameters
         ----------
         *pt : tuple
             Locations of x, y, z coordinates.
-        buffername : str
+        shapename : str
             Name of buffer property
 
         Returns
@@ -93,8 +123,8 @@ class Geom(BaseObject):
         at : bool
             Whether x,y is within the buffer.
         """
-        buffer = getattr(self, buffername)
-        return buffer.covers(Point(*pt))
+        shape = self.get_shape(shapename)
+        return shape.covers(Point(*pt))
 
     def all_at(self, *pt):
         """
@@ -114,15 +144,14 @@ class Geom(BaseObject):
         --------
         >>> exp = ExPoint()
         >>> exp.all_at(1.0, 1.0)
-        ['shape', 'on']
+        ['shape', 'on', 'around']
         >>> exp.all_at(1.0, 0.1)
-        ['on']
+        ['on', 'around']
         >>> exp.all_at(0.0, 0.0)
         []
         """
-        buffernames = ['shape', *self.buffers]
         all_at = []
-        for bname in buffernames:
+        for bname in self.shapenames:
             if self.at(pt, bname):
                 all_at.append(bname)
         return all_at
@@ -140,7 +169,7 @@ class Geom(BaseObject):
     def return_mutables(self):
         return astuple(self.s)
 
-    def vect_to_shape(self, pt, buffername='shape'):
+    def vect_to_shape(self, pt, shapename='shape'):
         """
         Gets the vector (x, y) to a given shape.
 
@@ -148,7 +177,7 @@ class Geom(BaseObject):
         ----------
         pt : tuple/list
             Point to get vector from
-        buffername : str
+        shapename : str
             Name of shape/buffer. Default is 'shape'.
 
         Examples
@@ -164,13 +193,13 @@ class Geom(BaseObject):
         array([[0.],
                [0.]])
         """
-        buffer = getattr(self, buffername)
+        shape = self.get_shape(shapename)
         geom_pt = Point(pt)
-        geom_c, close_pt = nearest_points(geom_pt, buffer)
+        geom_c, close_pt = nearest_points(geom_pt, shape)
         vect_to_shape = np.array(close_pt.xy) - np.array(geom_pt.xy)
         return vect_to_shape
 
-    def vect_at_shape(self, pt, buffername='shape', dist_forward=0.1):
+    def vect_at_shape(self, pt, shapename='shape', dist_forward=0.1):
         """
         Get the vector (x, y) at a given shape (e.g., direction of a line at pt).
 
@@ -178,7 +207,7 @@ class Geom(BaseObject):
         ----------
         pt : tuple/lost
             Point closest to shape
-        buffername : str
+        shapename : str
             Name of shape/buffer. Default is 'shape'.
         dist_forward : float
             Distance forward along line segment to project. Give a negative number to
@@ -194,11 +223,11 @@ class Geom(BaseObject):
         array([[ 0. ],
                [-0.1]])
         """
-        buffer = getattr(self, buffername)
+        shape = self.get_shape(shapename)
         geom_pt = Point(pt)
-        geom_c, close_pt = nearest_points(geom_pt, buffer)
-        line_dist = buffer.line_locate_point(geom_pt)
-        next_pt = buffer.line_interpolate_point(line_dist + dist_forward)
+        geom_c, close_pt = nearest_points(geom_pt, shape)
+        line_dist = shape.line_locate_point(geom_pt)
+        next_pt = shape.line_interpolate_point(line_dist + dist_forward)
         vect_at_shape = np.array(next_pt.xy) - np.array(close_pt.xy)
         return vect_at_shape
 
@@ -236,33 +265,37 @@ class Geom(BaseObject):
         if not ax:
             fig, ax = setup_plot(z=z, figsize=figsize)
         if 'all' in shapes:
-            shapes = {'shape': {}, **{v: {} for v in self.buffers}}
+            shapes = {s: {} for s in self.shapenames}
         if type(z) in (int, float):
             plot_kwargs = {'zs': z, 'zdir': 'z', **kwargs}
         else:
             plot_kwargs = kwargs
-        for shape, shape_kwargs in shapes.items():
+        for shapename, shape_kwargs in shapes.items():
             if geomlabel:
-                shape_label = geomlabel + "." + shape
+                shape_label = geomlabel + "." + shapename
             else:
-                shape_label = shape
+                shape_label = shapename
             local_kwargs = {**plot_kwargs, 'label': shape_label, **shape_kwargs}
-            shap = getattr(self, shape)
-            if isinstance(shap, Point):
-                ax.scatter(shap.x, shap.y, **local_kwargs)
-            elif isinstance(shap, LineString):
-                linecoords = np.array([*shap.coords])
+            shape = self.get_shape(shapename)
+            if isinstance(shape, Point):
+                ax.scatter(shape.x, shape.y, **local_kwargs)
+            elif isinstance(shape, LineString):
+                linecoords = np.array([*shape.coords])
                 ax.plot(linecoords[:, 0], linecoords[:, 1], **local_kwargs)
-            elif isinstance(shap, Polygon):
-                ax.plot(*shap.exterior.xy, **local_kwargs)
+            elif isinstance(shape, Polygon):
+                ax.plot(*shape.exterior.xy, **local_kwargs)
         ax.axis('equal')
         consolidate_legend(ax, **kwargs)
         return fig, ax
 
+    def assign_from(self, hist, t, *states):
+        """Update Geom state from a given history and time."""
+        self.s.assign(hist.s.get_slice(t), *states)
+
 
 class PointParam(Parameter):
     """
-    Parameter defining points. May be extended with buffers.
+    Parameter defining points. Extend with 'buffer_att' to create buffer shapes.
 
     Fields
     ------
@@ -271,6 +304,7 @@ class PointParam(Parameter):
     y : float
         y-location of point.
 
+
     Examples
     --------
     a point with center at 1.0, 1.0 and radius of 1.0 defining whether something
@@ -281,18 +315,13 @@ class PointParam(Parameter):
     ...    y: float = 1.0
     ...    buffer_on: float = 1.0
 
-    >>> expa = ExPointParam()
-    >>> expa.as_args()
-    ([1.0, 1.0],)
+    >>> ExPointParam()
+    ExPointParam(x=1.0, y=1.0, buffer_on=1.0)
     """
 
     x: ClassVar[float] = 0.0
     y: ClassVar[float] = 0.0
 
-    def as_args(self):
-        """Create arguments for shapely Point class based on fields."""
-        return ([self[i] for i in ['x', 'y', 'z'] if i in dir(self)], )
-
 
 class GeomPoint(Geom):
     """
@@ -304,6 +333,7 @@ class GeomPoint(Geom):
     Examples
     --------
     >>> class ExPoint(GeomPoint):
+    ...    __slots__ = ()
     ...    container_p = ExPointParam
     ...    container_s = ExGeomState
     >>> exp = ExPoint()
@@ -314,20 +344,42 @@ class GeomPoint(Geom):
     >>> exp.at((1.0, 0.1), "on")
     True
 
-    Additionally, note the underlying shapely attribute at .shape:
+    Additionally, note the underlying shapely attributes returned by get_shape:
 
-    >>> type(exp.shape)
+    >>> type(exp.get_shape())
     <class 'shapely.geometry.point.Point'>
 
     as well as the buffer (on):
 
-    >>> type(exp.on)
+    >>> type(exp.get_shape('on'))
     <class 'shapely.geometry.polygon.Polygon'>
+
+    Finally, note how geom characteristics defined as states can change:
+
+    >>> exp.at((3.0, 1.0), 'around') # outside the default area of `around` buffer
+    False
+    >>> exp.s.buffer_around = 2.0 # set to a larger radius to capture the point
+    >>> exp.at((3.0, 1.0), 'around')
+    True
     """
 
+    __slots__ = ()
     container_p = PointParam
     shapely_class = Point
 
+    def get_args(self):
+        """
+        Get shape arguments from Point parameter/state.
+
+        Examples
+        --------
+        >>> exp = ExPoint()
+        >>> exp.get_args()
+        (1.0, 1.0)
+        """
+        combodict = self.get_paramstates()
+        return tuple([combodict[i] for i in ['x', 'y', 'z'] if i in combodict])
+
 
 class ExGeomState(State):
     """
@@ -337,6 +389,7 @@ class ExGeomState(State):
     """
 
     occupied: bool = False
+    buffer_around: float = 1.0
 
 
 class ExPointParam(PointParam):
@@ -354,6 +407,7 @@ class ExPointParam(PointParam):
 class ExPoint(GeomPoint):
     """Example point for testing."""
 
+    __slots__ = ()
     container_p = ExPointParam
     container_s = ExGeomState
 
@@ -377,17 +431,12 @@ class LineParam(Parameter):
     >>> class ExLineParam(LineParam):
     ...     xys: tuple = ((0.0, 0.0), (1.0, 1.0))
     ...     buffer_on: float = 1.0
-    >>> exlp = ExLineParam()
-    >>> exlp.as_args()
-    (((0.0, 0.0), (1.0, 1.0)),)
+    >>> ExLineParam()
+    ExLineParam(xys=((0.0, 0.0), (1.0, 1.0)), buffer_on=1.0)
     """
 
     xys: ClassVar[tuple] = ()
 
-    def as_args(self):
-        """Create arguments for shapely LineString class based on fields."""
-        return (self.xys, )
-
 
 class ExLineParam(LineParam):
     """Example parameter defining a line with a given buffer 'on'."""
@@ -405,6 +454,7 @@ class GeomLine(Geom):
     Examples
     --------
     >>> class ExLine(GeomLine):
+    ...    __slots__ = ()
     ...    container_p = ExLineParam
     ...    container_s = ExGeomState
     >>> exp = ExLine()
@@ -415,24 +465,39 @@ class GeomLine(Geom):
     >>> exp.at((2.0, 2.0), "on")
     False
 
-    Additionally, note the underlying shapely attribute at .shape:
+    Additionally, note the underlying shapely objects returned by get_shape():
 
-    >>> type(exp.shape)
+    >>> type(exp.get_shape())
     <class 'shapely.geometry.linestring.LineString'>
 
     As well as the buffer (on):
 
-    >>> type(exp.on)
+    >>> type(exp.get_shape('on'))
     <class 'shapely.geometry.polygon.Polygon'>
     """
 
+    __slots__ = ()
     container_p = LineParam
     shapely_class = LineString
 
+    def get_args(self):
+        """
+        Create arguments for shapely LineString class based on fields.
+
+        Examples
+        --------
+        >>> exl = ExLine()
+        >>> exl.get_args()
+        (((0.0, 0.0), (1.0, 1.0)),)
+        """
+        combodict = self.get_paramstates()
+        return (combodict['xys'], )
+
 
 class ExLine(GeomLine):
     """Example GeomLine to use in testing."""
 
+    __slots__ = ()
     container_p = ExLineParam
     container_s = ExGeomState
 
@@ -441,8 +506,6 @@ class PolyParam(Parameter):
     """
     Parameter defining polygons. May be extended with buffers.
 
-    ...
-    
     Fields
     ------
     shell : tuple
@@ -455,20 +518,16 @@ class PolyParam(Parameter):
     The following PolyParam defines a hollow right triangle:
 
     >>> class ExPolyParam(PolyParam):
-    ...     shell: tuple = ((0.0, 0.0), (1.0, 0.0), (1.0, 1.0))
-    ...     holes: tuple = (((0.3, 0.2), (0.6, 0.2), (0.6, 0.5)), )
-    >>> expp = ExPolyParam()
-    >>> expp.as_args()
-    (((0.0, 0.0), (1.0, 0.0), (1.0, 1.0)), (((0.3, 0.2), (0.6, 0.2), (0.6, 0.5)),))
+    ...    __slots__ = ()
+    ...    shell: tuple = ((0.0, 0.0), (1.0, 0.0), (1.0, 1.0))
+    ...    holes: tuple = (((0.3, 0.2), (0.6, 0.2), (0.6, 0.5)), )
+    >>> ExPolyParam()
+    ExPolyParam(shell=((0.0, 0.0), (1.0, 0.0), (1.0, 1.0)), holes=(((0.3, 0.2), (0.6, 0.2), (0.6, 0.5)),))
     """
 
     shell: ClassVar[tuple] = ()
     holes: ClassVar[tuple] = ()
 
-    def as_args(self):
-        """Create arguments for shapely Polygon class based on fields."""
-        return self.shell, self.holes
-
 
 class ExPolyParam(PolyParam):
     """Example polygon parameter defining a basic triangle for use in testing."""
@@ -487,6 +546,7 @@ class GeomPoly(Geom):
     Examples
     --------
     >>> class ExPoly(GeomPoly):
+    ...    __slots__ = ()
     ...    container_p = ExPolyParam
     ...    container_s = ExGeomState
     >>> egp = ExPoly()
@@ -495,19 +555,32 @@ class GeomPoly(Geom):
     >>> egp.at((0.4, 0.3))
     False
 
-    Additionally, note the underlying shapely attribute at .shape:
+    Additionally, note the underlying shapely objects returned by get_shape():
 
-    >>> type(egp.shape)
+    >>> type(egp.get_shape())
     <class 'shapely.geometry.polygon.Polygon'>
     """
 
+    __slots__ = ()
     container_p = PolyParam
     shapely_class = Polygon
 
+    def get_args(self):
+        """Create arguments for shapely Polygon class based on fields.
+
+        Examples
+        --------
+        >>> ExPoly().get_args()
+        (((0.0, 0.0), (1.0, 0.0), (1.0, 1.0)), (((0.3, 0.2), (0.6, 0.2), (0.6, 0.5)),))
+        """
+        combodict = self.get_paramstates()
+        return combodict['shell'], combodict['holes']
+
 
 class ExPoly(GeomPoly):
     """Example Polygon for use in testing."""
 
+    __slots__ = ()
     container_p = ExPolyParam
     container_s = ExGeomState
 

{fmdtools-2.1.2 → fmdtools-2.1.3}/fmdtools.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: fmdtools
-Version: 2.1.2
+Version: 2.1.3
 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.1.2
+License: fmdtools version 2.1.3
         ---------------------------
                                          Apache License
                                    Version 2.0, January 2004
@@ -367,7 +367,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.1.2
+   git checkout v2.1.3
 ```
 
 
@@ -505,8 +505,8 @@ To cite a particular version of the fmdtools, you may use:
   author = {{NASA}},
   title = {fmdtools},
   url = {https://github.com/nasa/fmdtools},
-  version = {2.1.2},
-  date = {2025-5-19},
+  version = {2.1.3},
+  date = {2025-6-6},
 }
 ```
 

{fmdtools-2.1.2 → fmdtools-2.1.3}/pyproject.toml

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