plopp 25.7.0__tar.gz → 25.9.0__tar.gz

{plopp-25.7.0 → plopp-25.9.0}/.copier-answers.yml

@@ -1,9 +1,9 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: d3d4dc7
+_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.9.0/.github/workflows/nightly_at_main_lower_bound.yml

@@ -0,0 +1,37 @@
+name: Nightly test using lower bound dependencies
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '30 1 * * 1-5'
+
+jobs:
+  setup:
+    name: Setup variables
+    runs-on: 'ubuntu-24.04'
+    outputs:
+      min_python: ${{ steps.vars.outputs.min_python }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Get Python version for other CI jobs
+        id: vars
+        run: echo "min_python=$(< .github/workflows/python-version-ci)" >> "$GITHUB_OUTPUT"
+
+  tests:
+    name: Tests at lower bound
+    needs: setup
+    strategy:
+      matrix:
+        os: ['ubuntu-24.04']
+        python:
+          - version: '${{needs.setup.outputs.min_python}}'
+    runs-on: ${{ matrix.os }}
+    env:
+        ESS_PROTECTED_FILESTORE_USERNAME: ${{ secrets.ESS_PROTECTED_FILESTORE_USERNAME }}
+        ESS_PROTECTED_FILESTORE_PASSWORD: ${{ secrets.ESS_PROTECTED_FILESTORE_PASSWORD }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python.version }}
+      - run: uv run --extra=test --resolution=lowest-direct pytest

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

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

{plopp-25.7.0 → plopp-25.9.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.0 → plopp-25.9.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 ]
@@ -36,6 +35,8 @@ repos:
       - id: codespell
         additional_dependencies:
           - tomli
+        exclude_types:
+          - svg
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:

plopp-25.9.0/.python-version

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

plopp-25.9.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: plopp
+Version: 25.9.0
+Summary: Visualization library for Scipp
+Author: Scipp contributors
+License-Expression: BSD-3-Clause
+Project-URL: Bug Tracker, https://github.com/scipp/plopp/issues
+Project-URL: Documentation, https://scipp.github.io/plopp
+Project-URL: Source, https://github.com/scipp/plopp
+Classifier: Intended Audience :: Science/Research
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lazy-loader>=0.4
+Requires-Dist: matplotlib>=3.8
+Provides-Extra: scipp
+Requires-Dist: scipp>=25.5.0; extra == "scipp"
+Provides-Extra: all
+Requires-Dist: scipp>=25.5.0; extra == "all"
+Requires-Dist: ipympl>0.8.4; extra == "all"
+Requires-Dist: pythreejs>=2.4.1; extra == "all"
+Requires-Dist: mpltoolbox>=24.6.0; extra == "all"
+Requires-Dist: ipywidgets>=8.1.0; extra == "all"
+Requires-Dist: graphviz>=0.20.3; extra == "all"
+Provides-Extra: test
+Requires-Dist: graphviz>=0.20.3; extra == "test"
+Requires-Dist: h5py>=3.12; extra == "test"
+Requires-Dist: ipympl>=0.8.4; extra == "test"
+Requires-Dist: ipywidgets>=8.1.0; extra == "test"
+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>=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"
+Requires-Dist: scipy>=1.10.0; extra == "test"
+Requires-Dist: xarray>=v2024.05.0; extra == "test"
+Requires-Dist: anywidget>=0.9.0; extra == "test"
+Dynamic: license-file
+
+<img src="docs/_static/logo.svg" width="50%" />
+
+[![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/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
+
+## About
+
+Visualization library for Scipp
+
+## Installation
+
+```sh
+python -m pip install plopp
+```

{plopp-25.7.0 → plopp-25.9.0}/docs/about/index.md

@@ -2,11 +2,11 @@
 
 ## Development
 
-Plopp is an open source project by the [European Spallation Source ERIC](https://europeanspallationsource.se/) (ESS).
+Plopp is an open source project by the [European Spallation Source ERIC](https://ess.eu/) (ESS).
 
 ## License
 
-Plopp is available as open source under the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause).
+Plopp is available as open source under the [BSD-3 license](https://opensource.org/license/BSD-3-Clause).
 
 ## Citing Plopp
 

{plopp-25.7.0 → plopp-25.9.0}/docs/conf.py

@@ -32,6 +32,7 @@ extensions = [
     'sphinx_autodoc_typehints',
     'sphinx_copybutton',
     'sphinx_design',
+    'sphinxcontrib.autodoc_pydantic',
     'nbsphinx',
     'sphinx_gallery.load_style',
     'myst_parser',
@@ -248,6 +249,9 @@ doctest_default_flags = (
 linkcheck_ignore = [
     # Specific lines in Github blobs cannot be found by linkcheck.
     r'https?://github\.com/.*?/blob/[a-f0-9]+/.+?#',
+    # Linkcheck seems to be denied access by some DOI resolvers.
+    # Since DOIs are supposed to be permanent, we don't need to check them.'
+    r'https://doi\.org/',
 ]
 
 # -- Options for nbsphinx gallery------------------------------------------

plopp-25.9.0/docs/customization/animations.ipynb

@@ -0,0 +1,241 @@
+{
+ "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(norm=\"log\")"
+   ]
+  },
+  {
+   "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, vmin=-1, vmax=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, vmin=30, vmax=400, norm=\"log\")\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"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

{plopp-25.7.0 → plopp-25.9.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.0 → plopp-25.9.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.0 → plopp-25.9.0}/docs/index.md

@@ -24,10 +24,10 @@
 
 # {transparent}`Plopp`
 
-<span style="font-size:1.2em;font-style:italic;color:var(--pst-color-text-muted)">
+<div style="font-size:1.2em;font-style:italic;color:var(--pst-color-text-muted);text-align:center;">
   Visualization library for Scipp
   </br></br>
-</span>
+</div>
 
 
 ## Getting started
@@ -154,6 +154,10 @@
 
 :::
 
+:::{grid-item-card} Animations
+:link: customization/animations.ipynb
+:img-bottom: _static/customization/animation_2d.gif
+
 ::::
 
 ```{toctree}

{plopp-25.7.0 → plopp-25.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-  "setuptools>=68",
+  "setuptools>=77",
   "setuptools_scm[toml]>=8.0",
 ]
 build-backend = "setuptools.build_meta"
@@ -9,53 +9,52 @@ build-backend = "setuptools.build_meta"
 name = "plopp"
 description = "Visualization library for Scipp"
 authors = [{ name = "Scipp contributors" }]
-license = { file = "LICENSE" }
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
 readme = "README.md"
 classifiers = [
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: BSD License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Topic :: Scientific/Engineering",
     "Typing :: Typed",
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 
 # IMPORTANT:
 # Run 'tox -e deps' after making changes here. This will update requirement files.
 # Make sure to list one dependency per line.
 dependencies = [
-  "lazy-loader",
-  "matplotlib>=3.5",
+  "lazy-loader>=0.4",
+  "matplotlib>=3.8",
 ]
 
 dynamic = ["version"]
 
 [project.optional-dependencies]
-scipp = ["scipp"]
-all = ["scipp", "ipympl", "pythreejs", "mpltoolbox", "ipywidgets", "graphviz"]
+scipp = ["scipp>=25.5.0"]
+all = ["scipp>=25.5.0", "ipympl>0.8.4", "pythreejs>=2.4.1", "mpltoolbox>=24.6.0", "ipywidgets>=8.1.0", "graphviz>=0.20.3"]
 test = [
-    "graphviz",
-    "h5py",
-    "ipympl",
-    "ipywidgets",
-    "mpltoolbox",
-    "pandas",
-    "plotly",
-    "pooch",
-    "pyarrow",
-    "pytest",
-    "pythreejs",
-    "scipp",
-    "scipy",
-    "xarray",
-    "anywidget"
+    "graphviz>=0.20.3",
+    "h5py>=3.12",
+    "ipympl>=0.8.4",
+    "ipywidgets>=8.1.0",
+    "mpltoolbox>=24.6.0",
+    "pandas>=2.2.2",
+    "plotly>=5.15.0",
+    "pooch>=1.5",
+    "pyarrow>=13.0.0",
+    "pytest>=7.0",
+    "pythreejs>=2.4.1",
+    "scipp>=25.5.0",
+    "scipy>=1.10.0",
+    "xarray>=v2024.05.0",
+    "anywidget>=0.9.0"
 ]
 
 [project.urls]
@@ -84,6 +83,8 @@ filterwarnings = [
   'ignore:There is no current event loop:DeprecationWarning',
   # Should be removed once https://github.com/ipython/ipykernel/pull/1248 is released
   'ignore:Parsing dates involving a day of month without a year:DeprecationWarning',
+  # Should be removed once we lower pin a matplotlib version that respects the deprecation
+  'ignore:.*parameter is deprecated and will be removed in Pillow 13.*:DeprecationWarning',
 ]
 
 [tool.ruff]

{plopp-25.7.0 → plopp-25.9.0}/requirements/base.in

@@ -5,5 +5,5 @@ scipp
 # will not be touched by ``make_base.py``
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
-lazy-loader
-matplotlib>=3.5
+lazy-loader>=0.4
+matplotlib>=3.8

{plopp-25.7.0 → plopp-25.9.0}/requirements/base.txt

@@ -1,23 +1,23 @@
-# SHA1:b75ff651ebe8504f9d49c28d3320569f1b4de903
+# SHA1:fdb11dd5d28bac2a11ab529e4f383611e6e42b57
 #
 # This file was generated by pip-compile-multi.
 # To update, run:
 #
 #    requirements upgrade
 #
-contourpy==1.3.2
+contourpy==1.3.3
     # via matplotlib
 cycler==0.12.1
     # via matplotlib
-fonttools==4.58.1
+fonttools==4.59.0
     # via matplotlib
 kiwisolver==1.4.8
     # via matplotlib
 lazy-loader==0.4
     # via -r base.in
-matplotlib==3.10.3
+matplotlib==3.10.5
     # via -r base.in
-numpy==2.2.6
+numpy==2.3.2
     # via
     #   contourpy
     #   matplotlib
@@ -26,13 +26,13 @@ packaging==25.0
     # via
     #   lazy-loader
     #   matplotlib
-pillow==11.2.1
+pillow==11.3.0
     # via matplotlib
 pyparsing==3.2.3
     # via matplotlib
 python-dateutil==2.9.0.post0
     # via matplotlib
-scipp==25.5.1
+scipp==25.8.0
     # via -r base.in
 six==1.17.0
     # via python-dateutil

{plopp-25.7.0 → plopp-25.9.0}/requirements/basetest.in

@@ -7,18 +7,18 @@
 # will not be touched by ``make_base.py``
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
-graphviz
-h5py
-ipympl
-ipywidgets
-mpltoolbox
-pandas
-plotly
-pooch
-pyarrow
-pytest
-pythreejs
-scipp
-scipy
-xarray
-anywidget
+graphviz>=0.20.3
+h5py>=3.12
+ipympl>=0.8.4
+ipywidgets>=8.1.0
+mpltoolbox>=24.6.0
+pandas>=2.2.2
+plotly>=5.15.0
+pooch>=1.5
+pyarrow>=13.0.0
+pytest>=7.0
+pythreejs>=2.4.1
+scipp>=25.5.0
+scipy>=1.10.0
+xarray>=v2024.05.0
+anywidget>=0.9.0