plopp 25.6.1__py3-none-any.whl → 25.7.0__py3-none-any.whl

plopp/core/graph.py

@@ -23,8 +23,8 @@ def _make_graphviz_digraph(*args, **kwargs):
 def _walk_graph(start, nodes, edges, views, labels):
     label = (
         escape(str(start.func)) + '\nid = ' + start.id
-        if start.name is None
-        else escape(start.name)
+        if start.pretty_name is None
+        else escape(start.pretty_name)
     )
     nodes[start.id] = label
     for child in start.children:

plopp/core/helpers.py

@@ -38,6 +38,6 @@ def widget_node(widget) -> Node:
         ``ipywidgets`` library, or a custom widget.
     """
     n = Node(func=lambda: widget.value)
-    n.name = f'Widget <{type(widget).__name__}: {type(widget.value).__name__}>'
+    n.pretty_name = f'Widget <{type(widget).__name__}: {type(widget.value).__name__}>'
     widget.observe(n.notify_children, names="value")
     return n

plopp/core/node_class.py

@@ -64,10 +64,10 @@ class Node:
                 )
             )
             fname = getattr(self.func, "__name__", str(self.func))
-            self.name = f'{fname}({args_string})'
+            self.pretty_name = f'{fname}({args_string})'
         else:
             val_str = f'={func!r}' if isinstance(func, int | float | str) else ""
-            self.name = f'Input <{type(func).__name__}{val_str}>'
+            self.pretty_name = f'Input <{type(func).__name__}{val_str}>'
 
         # Attempt to set children after setting name in case error message is needed
         for parent in chain(self.parents, self.kwparents.values()):
@@ -194,7 +194,7 @@ class Node:
         return self.id == other.id
 
     def __repr__(self) -> str:
-        return f"Node(name={self.name})"
+        return f"Node(name={self.pretty_name})"
 
     def __add__(self, other: Node | Any) -> Node:
         return Node(lambda x, y: x + y, self, other)

plopp/plotting/common.py

@@ -285,7 +285,7 @@ def preprocess(
     check_not_binned(out)
     check_allowed_dtypes(out)
     if name is not None:
-        out.name = name
+        out.name = str(name)
     if not ignore_size:
         _check_size(out)
     if coords is not None:
@@ -316,9 +316,9 @@ def input_to_nodes(obj: PlottableMulti, processor: Callable) -> list[Node]:
     nodes = [Node(processor, inp, name=name) for name, inp in to_nodes]
     for node in nodes:
         if hasattr(processor, 'func'):
-            node.name = processor.func.__name__
+            node.pretty_name = processor.func.__name__
         else:
-            node.name = 'Preprocess data'
+            node.pretty_name = 'Preprocess data'
     return nodes
 
 

plopp/plotting/slicer.py

@@ -60,6 +60,7 @@ class Slicer:
         vmin: VariableLike | float = None,
         vmax: VariableLike | float = None,
         cbar: bool = True,
+        enable_player: bool = False,
         **kwargs,
     ):
         nodes = input_to_nodes(
@@ -98,7 +99,9 @@ class Slicer:
         from ..widgets import SliceWidget, slice_dims
 
         self.slider = SliceWidget(
-            nodes[0](), dims=[dim for dim in dims if dim not in keep]
+            nodes[0](),
+            dims=[dim for dim in dims if dim not in keep],
+            enable_player=enable_player,
         )
         self.slider_node = widget_node(self.slider)
         self.slice_nodes = [slice_dims(node, self.slider_node) for node in nodes]
@@ -130,6 +133,7 @@ def slicer(
     vmin: VariableLike | float = None,
     vmax: VariableLike | float = None,
     cbar: bool = True,
+    enable_player: bool = False,
     **kwargs,
 ) -> FigureLike:
     """
@@ -156,6 +160,10 @@ def slicer(
         The maximum value of the y-axis (1d plots) or color range (2d plots).
     cbar:
         Whether to display a colorbar for 2D plots.
+    enable_player:
+        Add a play button to animate the sliders if True. Defaults to False.
+
+        .. versionadded:: 25.07.0
     **kwargs:
         See :py:func:`plopp.plot` for the full list of figure customization arguments.
     """
@@ -167,5 +175,6 @@ def slicer(
         vmax=vmax,
         coords=coords,
         cbar=cbar,
+        enable_player=enable_player,
         **kwargs,
     ).figure

plopp/widgets/drawing.py

@@ -86,12 +86,12 @@ class DrawingTool(ToggleTool):
 
     def make_node(self, artist):
         draw_node = Node(self._get_artist_info(artist=artist, figure=self._figure))
-        draw_node.name = f'Draw node {len(self._draw_nodes)}'
+        draw_node.pretty_name = f'Draw node {len(self._draw_nodes)}'
         nodeid = draw_node.id
         self._draw_nodes[nodeid] = draw_node
         artist.nodeid = nodeid
         output_node = node(self._func)(self._input_node, draw_node)
-        output_node.name = f'Output node {len(self._output_nodes)}'
+        output_node.pretty_name = f'Output node {len(self._output_nodes)}'
         self._output_nodes[nodeid] = output_node
         if self._destination_is_fig:
             output_node.add_view(self._destination.view)

plopp/widgets/linesave.py

@@ -45,7 +45,7 @@ class LineSaveTool(VBar):
 
         data = self._data_node.request_data()
         node = Node(data)
-        node.name = f'Save node {len(self._lines)}'
+        node.pretty_name = f'Save node {len(self._lines)}'
         line_id = node._id
         node.add_view(self._fig.view)
         self._fig.view.render()

plopp/widgets/slice.py

@@ -12,74 +12,121 @@ from ..core.utils import coord_element_to_string
 from .box import VBar
 
 
+class DimSlicer(ipw.VBox):
+    def __init__(
+        self,
+        dim: str,
+        size: int,
+        coord: sc.Variable,
+        slider_constr: type[ipw.Widget],
+        enable_player: bool = False,
+    ):
+        if enable_player and not issubclass(slider_constr, ipw.IntSlider):
+            raise TypeError(
+                "Player can only be enabled for IntSlider, not for IntRangeSlider."
+            )
+        widget_args = {
+            'step': 1,
+            'description': dim,
+            'min': 0,
+            'max': size - 1,
+            'value': (size - 1) // 2 if slider_constr is ipw.IntSlider else None,
+            'continuous_update': True,
+            'readout': False,
+            'layout': {"width": "200px", "margin": "0px 0px 0px 10px"},
+            'style': {'description_width': 'initial'},
+        }
+        self.slider = slider_constr(**widget_args)
+        self.continuous_update = ipw.Checkbox(
+            value=True,
+            tooltip="Continuous update",
+            indent=False,
+            layout={"width": "20px"},
+        )
+        self.label = ipw.Label(
+            value=coord_element_to_string(coord[dim, self.slider.value])
+        )
+        ipw.jslink(
+            (self.continuous_update, 'value'), (self.slider, 'continuous_update')
+        )
+
+        children = [self.slider, self.continuous_update, self.label]
+        if enable_player:
+            self.player = ipw.Play(
+                value=self.slider.value,
+                min=self.slider.min,
+                max=self.slider.max,
+                step=self.slider.step,
+                interval=100,
+                description='Play',
+            )
+            ipw.jslink((self.player, 'value'), (self.slider, 'value'))
+            children.insert(0, self.player)
+
+        self.dim = dim
+        self.coord = coord
+        self.slider.observe(self._update_label, names='value')
+
+        super().__init__([ipw.HBox(children)])
+
+    def _update_label(self, change: dict[str, Any]):
+        """
+        Update the readout label with the coordinate value, instead of the integer
+        readout index.
+        """
+        self.label.value = coord_element_to_string(self.coord[self.dim, change['new']])
+
+    @property
+    def value(self) -> int | tuple[int, int]:
+        """
+        The value of the slider.
+        """
+        return self.slider.value
+
+    @value.setter
+    def value(self, value: int | tuple[int, int]):
+        self.slider.value = value
+
+
 class _BaseSliceWidget(VBar, ipw.ValueWidget):
-    def __init__(self, da: sc.DataArray, dims: list[str], slider_constr: ipw.Widget):
+    def __init__(
+        self,
+        da: sc.DataArray,
+        dims: list[str],
+        slider_constr: ipw.Widget,
+        enable_player: bool = False,
+    ):
         if isinstance(dims, str):
             dims = [dims]
-        self._slider_dims = dims
         self.controls = {}
         self.view = None
         children = []
 
-        for dim in self._slider_dims:
+        for dim in dims:
             coord = (
                 da.coords[dim]
                 if dim in da.coords
                 else sc.arange(dim, da.sizes[dim], unit=None)
             )
-            widget_args = {
-                'step': 1,
-                'description': dim,
-                'min': 0,
-                'max': da.sizes[dim] - 1,
-                'value': (da.sizes[dim] - 1) // 2
-                if slider_constr is ipw.IntSlider
-                else None,
-                'continuous_update': True,
-                'readout': False,
-                'layout': {"width": "200px"},
-                'style': {'description_width': 'initial'},
-            }
-            slider = slider_constr(**widget_args)
-            continuous_update = ipw.Checkbox(
-                value=True,
-                tooltip="Continuous update",
-                indent=False,
-                layout={"width": "20px"},
+            self.controls[dim] = DimSlicer(
+                dim=dim,
+                size=da.sizes[dim],
+                coord=coord,
+                slider_constr=slider_constr,
+                enable_player=enable_player,
             )
-            label = ipw.Label(value=coord_element_to_string(coord[dim, slider.value]))
-            ipw.jslink((continuous_update, 'value'), (slider, 'continuous_update'))
-
-            self.controls[dim] = {
-                'continuous': continuous_update,
-                'slider': slider,
-                'label': label,
-                'coord': coord,
-            }
-            slider.observe(self._update_label, names='value')
-            slider.observe(self._on_subwidget_change, names='value')
-            children.append(ipw.HBox([continuous_update, slider, label]))
+            self.controls[dim].slider.observe(self._on_subwidget_change, names='value')
+            children.append(self.controls[dim])
 
         self._on_subwidget_change()
         super().__init__(children)
 
-    def _update_label(self, change: dict[str, Any]):
-        """
-        Update the readout label with the coordinate value, instead of the integer
-        readout index.
-        """
-        dim = change['owner'].description
-        coord = self.controls[dim]['coord'][dim, change['new']]
-        self.controls[dim]['label'].value = coord_element_to_string(coord)
-
     def _on_subwidget_change(self, _=None):
         """
         Update the value of the widget.
         The value is a dict containing one entry per slider, giving the slider's value.
         """
-        self.value = {
-            dim: self.controls[dim]['slider'].value for dim in self._slider_dims
-        }
+        self.value = {dim: slicer.slider.value for dim, slicer in self.controls.items()}
 
 
 SliceWidget = partial(_BaseSliceWidget, slider_constr=ipw.IntSlider)
@@ -95,6 +142,10 @@ da:
     The input data array.
 dims:
     The dimensions to make sliders for.
+enable_player:
+    Add a play button to animate the slider if True. Defaults to False.
+
+    .. versionadded:: 25.07.0
 """
 
 RangeSliceWidget = partial(_BaseSliceWidget, slider_constr=ipw.IntRangeSlider)

{plopp-25.6.1.dist-info → plopp-25.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plopp
-Version: 25.6.1
+Version: 25.7.0
 Summary: Visualization library for Scipp
 Author: Scipp contributors
 License: BSD 3-Clause License
@@ -84,7 +84,7 @@ Dynamic: license-file
 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 [![PyPI badge](http://img.shields.io/pypi/v/plopp.svg)](https://pypi.python.org/pypi/plopp)
-[![Anaconda-Server Badge](https://anaconda.org/scipp/plopp/badges/version.svg)](https://anaconda.org/scipp/plopp)
+[![Anaconda-Server Badge](https://anaconda.org/conda-forge/plopp/badges/version.svg)](https://anaconda.org/conda-forge/plopp)
 [![Documentation](https://img.shields.io/badge/docs-online-success)](https://scipp.github.io/plopp/)
 [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
 [![DOI](https://zenodo.org/badge/528859752.svg)](https://zenodo.org/badge/latestdoi/528859752)

{plopp-25.6.1.dist-info → plopp-25.7.0.dist-info}/RECORD

@@ -25,10 +25,10 @@ plopp/backends/pythreejs/outline.py,sha256=WUqtUj8GMAUzUqOocFjdT8F7WBeV9jgMSYmXD
 plopp/backends/pythreejs/scatter3d.py,sha256=Z8D0l3hBJ2qlC4BIAAoHCAa97uf6IViFNt23f9wzFFI,7049
 plopp/core/__init__.py,sha256=s25RIbKplHSRn0jjtLADPQl72JLf_KLRMRCfeMDI_UA,205
 plopp/core/__init__.pyi,sha256=FU5U5nymhzbgBRolZSh1tqYDJ3M2djUv71mriWHD1hI,294
-plopp/core/graph.py,sha256=beHDxqF4C-6wd18TkYue3KqYutEYJ2EwoEBbWIqWQNs,3841
-plopp/core/helpers.py,sha256=Dua9KWOk2cCpDyWPUrak6kymUx7QvjRI2LNJRoGDMcY,1193
+plopp/core/graph.py,sha256=dTJa1QIQDEuDUYZIwF7NT444wkuXxb0wwBrx311vTT8,3855
+plopp/core/helpers.py,sha256=BVunzkcYOXoYjawutFtKP8WbWN1h1OlRrSd_i9TY090,1200
 plopp/core/limits.py,sha256=ojb3MTxlWNz2ibHXu9P-agzYV8HxPCGSB2D0oxoO9RQ,3572
-plopp/core/node_class.py,sha256=5SnVELRZSzcTD1ku8hDkWygCWsDMpedvcyYGZV-CHlw,7462
+plopp/core/node_class.py,sha256=Vzjf0f7UTiCVZC8m_dwh2gGPwnJqD0HOR8HuUX5TsDI,7483
 plopp/core/typing.py,sha256=JL_mMdFq2dNu6LuZYSBfOXGZSEn0VIJK_lr-LbC11t4,2903
 plopp/core/utils.py,sha256=qxdOLRODgv3b0dDywT0JomsVrgifS_siC-ZpzJqgblo,7120
 plopp/core/view.py,sha256=9WulgLHg8aPjePz967WLWieTM40dvqlgJitu-AS3WdM,1972
@@ -47,13 +47,13 @@ plopp/graphics/graphicalview.py,sha256=07xpJVnvuNlaWGsJshg_wL81jG57JhRxI23E7_WYI
 plopp/graphics/tiled.py,sha256=gXYZVAs6wRFKezzN3VlEvm7_z2zx3IDYfGZQZqrpL80,1386
 plopp/plotting/__init__.py,sha256=s25RIbKplHSRn0jjtLADPQl72JLf_KLRMRCfeMDI_UA,205
 plopp/plotting/__init__.pyi,sha256=95wYGfM5PT0Y0Ov_ue7rBrHvHxrtex-2WEYtfFzBvE0,475
-plopp/plotting/common.py,sha256=_DmUEpWk2n4uz2-KwhzdctbC0WvRU9GsAMFDgfPnUo8,10965
+plopp/plotting/common.py,sha256=dwtOpmMNY8deLWskiByKXficZUqX1pPGrkT_ieDN36c,10984
 plopp/plotting/inspector.py,sha256=fT4v342pqTzihKaweoGD4WaQ5eDdyngK7W451Mh2Ffw,3586
 plopp/plotting/mesh3d.py,sha256=KjAtlVlLYslwgP_uE067WtJRgNURkhaz0PPUuYLlJyw,2778
 plopp/plotting/plot.py,sha256=WQzw1vHGljWY1tQU1InQWe2-M-vCW2IRiL-v7cnw46w,3886
 plopp/plotting/scatter.py,sha256=ybPWFHFwxt_Bzv3Dy-yAFCRHW5HQEggcNihpzWduH7A,3161
 plopp/plotting/scatter3d.py,sha256=oizd-BCgmvNu_fSV6FQt9oe7lPn4h2Zc1ohKmor-d78,3819
-plopp/plotting/slicer.py,sha256=A3g26czD6GM3vBlVS-IBOnCOlpaERqUhjT-_POYJEHQ,5877
+plopp/plotting/slicer.py,sha256=ym20mXJtp_msGOet18wr0mb4TL0z4ti6W9uFo_5cvKc,6169
 plopp/plotting/superplot.py,sha256=0EnzgSmNrdPHXooqj6GNR0IAApEHyfjgxYIPgPVO_5o,1416
 plopp/plotting/xyplot.py,sha256=zi-RcsgonnR747aH3zp75at4ntgZ0t0rSdKEeVlReMI,1641
 plopp/widgets/__init__.py,sha256=s25RIbKplHSRn0jjtLADPQl72JLf_KLRMRCfeMDI_UA,205
@@ -62,14 +62,14 @@ plopp/widgets/box.py,sha256=v5Gd3sY0WXcc3UfkcXxZboPG02sfOMXIo50tmpxPwVs,1806
 plopp/widgets/checkboxes.py,sha256=52yJryEu1upYafFxqoTOdAZmHeKzCI_CJiCWSezCtRA,2430
 plopp/widgets/clip3d.py,sha256=L90HUd3bjEU3BaPdK8DnUbeeFNqfFyBWDEwaG9nP-M8,14602
 plopp/widgets/debounce.py,sha256=V5aIcnb465oqXZX-UG_DR7GjvoG6D_C2jjEUBmguGDA,1292
-plopp/widgets/drawing.py,sha256=3aWEYUXsNNBJFey-7cPXbQ4bLQpDbIJe-kSNB2yonbE,6238
-plopp/widgets/linesave.py,sha256=FAM1toc71fg3SfRrU-r_KXjHKBOJU4qKXs5bebReNiU,2451
-plopp/widgets/slice.py,sha256=ihiGEGGva_2WZIug-kizg1I5SFdMzu4_8DDzuHWIKeA,4212
+plopp/widgets/drawing.py,sha256=Pcozffq7I5H9x57GNBJVvkCjVR6eaPBuxyHlFkEEjzQ,6252
+plopp/widgets/linesave.py,sha256=s5QcY-31x7Hvf9iLHmzfFIzodXTD9BX0Av3NlG8GS88,2458
+plopp/widgets/slice.py,sha256=hG1QzLsjmxjY4fjQwtlu8GxK6zzalrZsZxZzhwIaskg,5499
 plopp/widgets/style.py,sha256=Fw4S8te0xDyT8-kWu4Ut35aLgyr98qMlWZRbXbd1-dk,184
 plopp/widgets/toolbar.py,sha256=ueNeOZSC2suAG7nCJzqwl8DmtWD5c2J8VkuP-XzJRwI,4683
 plopp/widgets/tools.py,sha256=9l7LmB8qG0OTt5ZJihJzqRna1ouxJthO_Ahnq7WKTtY,7172
-plopp-25.6.1.dist-info/licenses/LICENSE,sha256=fCqnkzCwkGneGtgOidkO2b3ed6SGZT0yhuworuJG0K0,1553
-plopp-25.6.1.dist-info/METADATA,sha256=1rzml_3ajA-prOwWEd_8KI8EfxZiyV6DRFcl3nTvf68,4533
-plopp-25.6.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-plopp-25.6.1.dist-info/top_level.txt,sha256=Lk_GLFh37eX-3PO3c6bPkDpir7GjJmbQHYza3IpIphc,6
-plopp-25.6.1.dist-info/RECORD,,
+plopp-25.7.0.dist-info/licenses/LICENSE,sha256=fCqnkzCwkGneGtgOidkO2b3ed6SGZT0yhuworuJG0K0,1553
+plopp-25.7.0.dist-info/METADATA,sha256=ORDD8s280azbvWqw84HVSpZ9uZ1HoGB8L13Uf7LTyVg,4545
+plopp-25.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+plopp-25.7.0.dist-info/top_level.txt,sha256=Lk_GLFh37eX-3PO3c6bPkDpir7GjJmbQHYza3IpIphc,6
+plopp-25.7.0.dist-info/RECORD,,