plopp 25.7.1__tar.gz → 25.10.0__tar.gz

{plopp-25.7.1 → plopp-25.10.0}/.copier-answers.yml

@@ -1,9 +1,9 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 3561fcd
+_commit: c3214e6
 _src_path: https://github.com/scipp/copier_template.git
 description: Visualization library for Scipp
 max_python: '3.13'
-min_python: '3.10'
+min_python: '3.11'
 namespace_package: ''
 nightly_deps: scipp
 orgname: scipp

plopp-25.10.0/.github/workflows/python-version-ci

@@ -0,0 +1 @@
+3.11

{plopp-25.7.1 → plopp-25.10.0}/.github/workflows/release.yml

@@ -33,7 +33,7 @@ jobs:
 
   upload_pypi:
     name: Deploy PyPI
-    needs: build_wheels
+    needs: [build_wheels]
     runs-on: 'ubuntu-24.04'
     environment: release
     permissions:
@@ -44,7 +44,7 @@ jobs:
       - uses: pypa/gh-action-pypi-publish@v1.12.4
 
   docs:
-    needs: upload_pypi
+    needs: [upload_pypi]
     uses: ./.github/workflows/docs.yml
     with:
       publish: ${{ github.event_name == 'release' && github.event.action == 'published' }}

{plopp-25.7.1 → plopp-25.10.0}/.pre-commit-config.yaml

@@ -10,7 +10,6 @@ repos:
       - id: check-merge-conflict
       - id: check-toml
       - id: check-yaml
-        exclude: conda/meta.yaml
       - id: detect-private-key
       - id: trailing-whitespace
         args: [ --markdown-linebreak-ext=md ]

plopp-25.10.0/.python-version

@@ -0,0 +1 @@
+3.11

{plopp-25.7.1 → plopp-25.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plopp
-Version: 25.7.1
+Version: 25.10.0
 Summary: Visualization library for Scipp
 Author: Scipp contributors
 License-Expression: BSD-3-Clause
@@ -12,13 +12,12 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Typing :: Typed
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lazy-loader>=0.4
@@ -41,7 +40,7 @@ Requires-Dist: mpltoolbox>=24.6.0; extra == "test"
 Requires-Dist: pandas>=2.2.2; extra == "test"
 Requires-Dist: plotly>=5.15.0; extra == "test"
 Requires-Dist: pooch>=1.5; extra == "test"
-Requires-Dist: pyarrow>=10.0.0; extra == "test"
+Requires-Dist: pyarrow>=13.0.0; extra == "test"
 Requires-Dist: pytest>=7.0; extra == "test"
 Requires-Dist: pythreejs>=2.4.1; extra == "test"
 Requires-Dist: scipp>=25.5.0; extra == "test"

plopp-25.10.0/docs/customization/animations.ipynb

@@ -0,0 +1,242 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0",
+   "metadata": {},
+   "source": [
+    "# Animations\n",
+    "\n",
+    "To create animations with Plopp, we make use of the [node mechanism](custom-interfaces.ipynb)\n",
+    "and leverage [Matplotlib's support for animations](https://matplotlib.org/stable/users/explain/animations/animations.html).\n",
+    "\n",
+    "## 1D animations"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import plopp as pp\n",
+    "from plopp.data.examples import three_bands\n",
+    "import matplotlib.animation as animation"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "2",
+   "metadata": {},
+   "source": [
+    "We load the data and display it in a figure:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "da = three_bands()\n",
+    "da.plot(logc=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4",
+   "metadata": {},
+   "source": [
+    "We now create an animation where we are scanning the vertical `y` direction of the data,\n",
+    "making a plot of each slice in each step of the animation.\n",
+    "\n",
+    "On every call to the `update` function passed to Matplotlib's `FuncAnimation`,\n",
+    "we update the index node and notify the children nodes of the change.\n",
+    "This updates the figure at every step.\n",
+    "\n",
+    "Finally, we save the animation to a `.gif` file.\n",
+    "See [here](https://matplotlib.org/stable/users/explain/animations/animations.html#saving-animations)\n",
+    "for the possible formats animations can be saved in."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "data_node = pp.Node(da)\n",
+    "index_node = pp.Node(0)\n",
+    "# Here, 'y' is the dimension you want to slice\n",
+    "slice_node = pp.Node(lambda da, ind: da[\"y\", ind], da=data_node, ind=index_node)\n",
+    "\n",
+    "f = pp.linefigure(slice_node, ymin=-1, ymax=200)\n",
+    "\n",
+    "\n",
+    "def update(frame):\n",
+    "    index_node.func = lambda: frame\n",
+    "    index_node.notify_children(\"\")\n",
+    "\n",
+    "\n",
+    "ani = animation.FuncAnimation(fig=f.fig, func=update, frames=200, interval=100)\n",
+    "ani.save(filename=\"animation_1d.gif\", writer=\"pillow\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6",
+   "metadata": {},
+   "source": [
+    "### Displaying the animation in the notebook\n",
+    "\n",
+    "There are (at least) three different ways to display the animation directly in the notebook.\n",
+    "\n",
+    "#### Markdown\n",
+    "\n",
+    "The first is to create a markdown cell and just display the image (note that refreshing browser window may be required in some cases):\n",
+    "\n",
+    "```\n",
+    "![ani](animation_1d.gif)\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7",
+   "metadata": {},
+   "source": [
+    "![ani](animation_1d.gif)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8",
+   "metadata": {},
+   "source": [
+    "#### Display the interactive figure\n",
+    "\n",
+    "The second method is to simply display the figure `f` define above,\n",
+    "but **this only works if `%matplotlib widget` is enabled** (and does not work in the rendered docs, hence not shown here).\n",
+    "The advantage of this method is that it does not require first saving the animation to disk.\n",
+    "\n",
+    "#### Ipywidgets\n",
+    "\n",
+    "The third method is to use `ipywidgets` to display the image in the file:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import ipywidgets as ipw\n",
+    "\n",
+    "ipw.Image(value=open(\"animation_1d.gif\", \"rb\").read(), format=\"gif\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "10",
+   "metadata": {},
+   "source": [
+    "## 2D animations\n",
+    "\n",
+    "We can create a similar animation on 2d images,\n",
+    "where instead of slicing the vertical dimension,\n",
+    "we collect more and more signal as time progresses.\n",
+    "\n",
+    "Every time the `update` function is called,\n",
+    "new data is created and added to the current data."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "11",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "da = three_bands(npeaks=20, per_peak=500, spread=30.0)\n",
+    "data_node = pp.Node(da)\n",
+    "\n",
+    "f = pp.imagefigure(data_node, cbar=True, cmin=30, cmax=400, logc=True)\n",
+    "\n",
+    "\n",
+    "def update(frame):\n",
+    "    # Make new data and add it to the current data.\n",
+    "    # The current data is obtained by calling the `data_node()`\n",
+    "    new = three_bands(npeaks=20, per_peak=500, spread=30.0) + data_node()\n",
+    "    data_node.func = lambda: new\n",
+    "    data_node.notify_children(\"\")\n",
+    "\n",
+    "\n",
+    "ani = animation.FuncAnimation(fig=f.fig, func=update, frames=80, interval=100)\n",
+    "ani.save(filename=\"animation_2d.gif\", writer=\"pillow\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "12",
+   "metadata": {},
+   "source": [
+    "We now display the resulting animation (using markdown):\n",
+    "\n",
+    "![ani2](animation_2d.gif)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "13",
+   "metadata": {},
+   "source": [
+    "## 3D animations\n",
+    "\n",
+    "Animations on 3D plots are currently not supported.\n",
+    "\n",
+    "The best way to achieve this would be to record a screencast while interacting with a 3D scene."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "14",
+   "metadata": {
+    "nbsphinx": "hidden"
+   },
+   "outputs": [],
+   "source": [
+    "# This cell is used to generate the thumbnail for the docs.\n",
+    "# It is hidden from the online documentation.\n",
+    "import shutil\n",
+    "\n",
+    "shutil.copyfile(\"animation_2d.gif\", \"../_static/customization/animation_2d.gif\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

{plopp-25.7.1 → plopp-25.10.0}/docs/customization/index.md

@@ -30,6 +30,12 @@
 
 :::
 
+::::{grid-item-card} Animations
+:link: animations.ipynb
+:img-bottom: ../_static/customization/animation_2d.gif
+
+:::
+
 ::::
 
 ```{toctree}
@@ -41,4 +47,5 @@ subplots
 tweaking-figures
 custom-interfaces
 graph-node-tips
+animations
 ```

{plopp-25.7.1 → plopp-25.10.0}/docs/customization/tweaking-figures.ipynb

@@ -77,8 +77,7 @@
    },
    "outputs": [],
    "source": [
-    "p = pp.plot(da)\n",
-    "p"
+    "pp.plot(da)"
    ]
   },
   {
@@ -92,7 +91,7 @@
     "tags": []
    },
    "source": [
-    "To change the label of the vertical axis, use the `.canvas.ylabel` property on the plot object:"
+    "To change the label of the horizontal or vertical axes, use the `xlabel/ylabel` arguments:"
    ]
   },
   {
@@ -108,8 +107,7 @@
    },
    "outputs": [],
    "source": [
-    "p.canvas.ylabel = 'Phase of sound wave'\n",
-    "p"
+    "pp.plot(da, xlabel=\"Time (milliseconds)\", ylabel=\"Phase of sound wave\")"
    ]
   },
   {
@@ -145,6 +143,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "9",
    "metadata": {
@@ -155,12 +154,10 @@
     "tags": []
    },
    "source": [
-    "### Setting the axis range\n",
-    "\n",
-    "#### Vertical axis\n",
+    "### Setting the axes ranges\n",
     "\n",
-    "Changing the range of the vertical axis is done using the `vmin` and `vmax` arguments\n",
-    "(note that if only one of the two is given, then the other will be automatically determined from the data plotted)."
+    "Changing the range of the horizontal or vertical axes is done using the `xmin/xmax` and `ymax/ymax` arguments, respectively.\n",
+    "If only the `min` or `max` is given, then the other will be automatically determined from the data plotted."
    ]
   },
   {
@@ -170,7 +167,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pp.plot(da, vmin=sc.scalar(-0.5, unit='m/s'), vmax=sc.scalar(1.5, unit='m/s'))"
+    "pp.plot(\n",
+    "    da,\n",
+    "    xmin=sc.scalar(10, unit='m'),\n",
+    "    ymin=sc.scalar(-0.5, unit='m/s'),\n",
+    "    ymax=sc.scalar(1.5, unit='m/s'),\n",
+    ")"
    ]
   },
   {
@@ -185,11 +187,7 @@
    },
    "source": [
     "Note that if the unit in the supplied limits is not identical to the data units, an on-the-fly conversion is attempted.\n",
-    "It is also possible to omit the units altogether, in which case it is assumed the unit is the same as the data unit.\n",
-    "\n",
-    "#### Horizontal axis\n",
-    "\n",
-    "The easiest way to set the range of the horizontal axis is to slice the data before plotting:"
+    "It is also possible to omit the units altogether, in which case it is assumed the unit is the same as the data unit:"
    ]
   },
   {
@@ -205,34 +203,13 @@
    },
    "outputs": [],
    "source": [
-    "pp.plot(da[10:40])"
+    "pp.plot(da, xmin=10, xmax=45)"
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "13",
-   "metadata": {},
-   "source": [
-    "Note that this will add some padding around the plotted data points.\n",
-    "\n",
-    "If you wish to have precise control over the limits, you can use the lower-level `canvas.xrange` property:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "14",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p = da.plot()\n",
-    "p.canvas.xrange = [10, 40]\n",
-    "p"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "15",
    "metadata": {
     "editable": true,
     "slideshow": {
@@ -241,34 +218,21 @@
     "tags": []
    },
    "source": [
-    "Note that `camvas.yrange` is also available, and is equivalent to using the `vmin` and `vmax` arguments.\n",
-    "\n",
     "## Further modifications\n",
     "\n",
     "Instead of providing keyword arguments for tweaking every aspect of the figures,\n",
     "we provide accessors to the underlying Matplotlib `Figure` and `Axes` objects,\n",
-    "that can then directly be used to make the required modifications."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "16",
-   "metadata": {
-    "editable": true,
-    "slideshow": {
-     "slide_type": ""
-    },
-    "tags": []
-   },
-   "source": [
+    "that can then directly be used to make the required modifications.\n",
+    "\n",
     "### Tick locations and labels\n",
+    "\n",
     "To change the location of the ticks, as well as their labels, we directly access the Matplotlib axes via the `.ax` property of the figure:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "17",
+   "id": "14",
    "metadata": {
     "editable": true,
     "slideshow": {
@@ -286,7 +250,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "18",
+   "id": "15",
    "metadata": {},
    "source": [
     "### Axes placement\n",
@@ -298,7 +262,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "19",
+   "id": "16",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -319,7 +283,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "20",
+   "id": "17",
    "metadata": {},
    "source": [
     "It is also possible to control the placement of the colorbar for image plots using the `cax` argument:"
@@ -328,7 +292,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "21",
+   "id": "18",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -357,7 +321,8 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

{plopp-25.7.1 → plopp-25.10.0}/docs/developer/getting-started.md

@@ -40,7 +40,7 @@ Alternatively, if you want a different workflow, take a look at ``tox.ini`` or `
 Run the tests using
 
 ```sh
-tox -e py310
+tox -e py311
 ```
 
 (or just `tox` if you want to run all environments).

{plopp-25.7.1 → plopp-25.10.0}/docs/gallery/interactive-masking.ipynb

@@ -181,7 +181,7 @@
     "\n",
     "masking_node = pp.Node(apply_masks, data_node)\n",
     "\n",
-    "fig = pp.imagefigure(masking_node, norm='log')\n",
+    "fig = pp.imagefigure(masking_node, logc=True)\n",
     "\n",
     "r = RectangleTool(\n",
     "    figure=fig, input_node=data_node, func=define_mask, destination=masking_node\n",

{plopp-25.7.1 → plopp-25.10.0}/docs/gallery/masking-a-range.ipynb

@@ -123,7 +123,7 @@
     "sum_node = pp.Node(sc.sum, mask_node, dim=ydim)\n",
     "\n",
     "# Make figures\n",
-    "image = pp.imagefigure(mask_node, norm='log')\n",
+    "image = pp.imagefigure(mask_node, logc=True)\n",
     "lines = pp.linefigure(sum_node, grid=True, ls='solid', marker='')\n",
     "ipw.VBox([slider, image, lines])"
    ]

{plopp-25.7.1 → plopp-25.10.0}/docs/gallery/peeling-layers.ipynb

@@ -103,7 +103,7 @@
     "b = da[(da.data > sc.scalar(0.002)) & (da.data < sc.scalar(0.005))]\n",
     "\n",
     "# Display both on the same scatter plot\n",
-    "p = pp.scatter3d({'a': a, 'b': b}, pos='position', norm='log', cbar=True)\n",
+    "p = pp.scatter3d({'a': a, 'b': b}, pos='position', logc=True, cbar=True)\n",
     "\n",
     "# Extract the point clouds from the final plot and set a lower opacity on the second point cloud\n",
     "clouds = list(p.artists.values())\n",

{plopp-25.7.1 → plopp-25.10.0}/docs/gallery/rectangle-selection.ipynb

@@ -154,7 +154,7 @@
     "\n",
     "data_node = pp.Node(da)\n",
     "\n",
-    "f2d = pp.imagefigure(data_node, norm='log')\n",
+    "f2d = pp.imagefigure(data_node, logc=True)\n",
     "f1d = pp.linefigure()\n",
     "\n",
     "r = RectangleTool(figure=f2d, input_node=data_node, func=vertical_sum, destination=f1d)\n",

{plopp-25.7.1 → plopp-25.10.0}/docs/gallery/streaming-plot.ipynb

@@ -101,7 +101,7 @@
     "stream_node = pp.Node(data, iteration=play_node)\n",
     "\n",
     "# Plot on a figure\n",
-    "fig = pp.imagefigure(stream_node, norm=\"log\", cbar=True)"
+    "fig = pp.imagefigure(stream_node, logc=True, cbar=True)"
    ]
   },
   {

{plopp-25.7.1 → plopp-25.10.0}/docs/getting-started/overview.ipynb

@@ -251,8 +251,7 @@
    "source": [
     "## Logarithmic scale\n",
     "\n",
-    "Data can be plotted on a logarithmic scale on one or both axes.\n",
-    "For the independent axis (the coordinate axis, i.e., the horizontal axis) this can be set using the `scale` option:"
+    "Data can be plotted on a logarithmic scale on one or both axes using the `logx` and `logy` arguments:"
    ]
   },
   {
@@ -261,7 +260,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da1.plot(scale={'x': 'log'})"
+    "da1.plot(logx=True)"
    ]
   },
   {
@@ -270,21 +269,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da.plot(scale={'x': 'log', 'time': 'log'})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Note the the keys in the `scale` dict are dimension labels and *not* \"x\" and \"y\" as Matplotlib would refer to its axes."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "For the dependent axis (the data axis, i.e., vertical axis) use the `norm` option:"
+    "(100 * (da1 - da1.min())).plot(logy=True)"
    ]
   },
   {
@@ -293,7 +278,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "(100 * (da1 - da1.min())).plot(norm='log')"
+    "da.plot(logx=True, logy=True)"
    ]
   }
  ],
@@ -312,7 +297,8 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

{plopp-25.7.1 → plopp-25.10.0}/docs/index.md

@@ -154,6 +154,10 @@
 
 :::
 
+:::{grid-item-card} Animations
+:link: customization/animations.ipynb
+:img-bottom: _static/customization/animation_2d.gif
+
 ::::
 
 ```{toctree}