essreduce 25.5.1__tar.gz → 25.5.3__tar.gz

{essreduce-25.5.1/src/essreduce.egg-info → essreduce-25.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: essreduce
-Version: 25.5.1
+Version: 25.5.3
 Summary: Common data reduction tools for the ESS facility
 Author: Scipp contributors
 License: BSD 3-Clause License
@@ -51,7 +51,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: sciline>=25.04.1
+Requires-Dist: sciline>=25.05.1
 Requires-Dist: scipp>=25.01.0
 Requires-Dist: scippneutron>=25.02.0
 Requires-Dist: scippnexus>=24.11.0

{essreduce-25.5.1 → essreduce-25.5.3}/docs/user-guide/tof/dream.ipynb

@@ -306,7 +306,9 @@
    "outputs": [],
    "source": [
     "wf = time_of_flight.GenericTofWorkflow(\n",
-    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF\n",
+    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF,\n",
+    "    run_types=[SampleRun],\n",
+    "    monitor_types=[],\n",
     ")\n",
     "wf[DetectorData[SampleRun]] = raw_data\n",
     "wf[time_of_flight.DetectorLtotal[SampleRun]] = Ltotal\n",

{essreduce-25.5.1 → essreduce-25.5.3}/docs/user-guide/tof/frame-unwrapping.ipynb

@@ -160,7 +160,9 @@
    "outputs": [],
    "source": [
     "wf = time_of_flight.GenericTofWorkflow(\n",
-    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF\n",
+    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF,\n",
+    "    run_types=[SampleRun],\n",
+    "    monitor_types=[],\n",
     ")\n",
     "\n",
     "wf[DetectorData[SampleRun]] = nxevent_data\n",
@@ -371,7 +373,9 @@
    "outputs": [],
    "source": [
     "wf = time_of_flight.GenericTofWorkflow(\n",
-    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF\n",
+    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF,\n",
+    "    run_types=[SampleRun],\n",
+    "    monitor_types=[],\n",
     ")\n",
     "\n",
     "nxevent_data = results.to_nxevent_data()\n",

{essreduce-25.5.1 → essreduce-25.5.3}/docs/user-guide/tof/wfm.ipynb

@@ -327,7 +327,9 @@
    "outputs": [],
    "source": [
     "wf = time_of_flight.GenericTofWorkflow(\n",
-    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF\n",
+    "    tof_lut_provider=time_of_flight.TofLutProvider.TOF,\n",
+    "    run_types=[SampleRun],\n",
+    "    monitor_types=[],\n",
     ")\n",
     "wf[DetectorData[SampleRun]] = raw_data\n",
     "wf[time_of_flight.DetectorLtotal[SampleRun]] = Ltotal\n",

{essreduce-25.5.1 → essreduce-25.5.3}/pyproject.toml

@@ -31,7 +31,7 @@ requires-python = ">=3.10"
 # Run 'tox -e deps' after making changes here. This will update requirement files.
 # Make sure to list one dependency per line.
 dependencies = [
-    "sciline>=25.04.1",
+    "sciline>=25.05.1",
     "scipp>=25.01.0",
     "scippneutron>=25.02.0",
     "scippnexus>=24.11.0",

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/base.in

@@ -2,7 +2,7 @@
 # will not be touched by ``make_base.py``
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
-sciline>=25.04.1
+sciline>=25.05.1
 scipp>=25.01.0
 scippneutron>=25.02.0
 scippnexus>=24.11.0

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/base.txt

@@ -1,4 +1,4 @@
-# SHA1:082d6bf55d8a06cdc1dd3a0a78dd31c318c26424
+# SHA1:da1d0d3975da182dcdb34676612971ba09dbdc53
 #
 # This file was generated by pip-compile-multi.
 # To update, run:
@@ -17,7 +17,7 @@ dnspython==2.7.0
     # via email-validator
 email-validator==2.2.0
     # via scippneutron
-fonttools==4.57.0
+fonttools==4.58.0
     # via matplotlib
 h5py==3.13.0
     # via
@@ -31,7 +31,7 @@ lazy-loader==0.4
     # via
     #   plopp
     #   scippneutron
-matplotlib==3.10.1
+matplotlib==3.10.3
     # via
     #   mpltoolbox
     #   plopp
@@ -39,7 +39,7 @@ mpltoolbox==25.4.0
     # via scippneutron
 networkx==3.4.2
     # via cyclebane
-numpy==2.2.5
+numpy==2.2.6
     # via
     #   contourpy
     #   h5py
@@ -66,20 +66,20 @@ python-dateutil==2.9.0.post0
     #   matplotlib
     #   scippneutron
     #   scippnexus
-sciline==25.4.1
+sciline==25.5.1
     # via -r base.in
 scipp==25.5.0
     # via
     #   -r base.in
     #   scippneutron
     #   scippnexus
-scippneutron==25.2.1
+scippneutron==25.5.0
     # via -r base.in
 scippnexus==25.4.0
     # via
     #   -r base.in
     #   scippneutron
-scipy==1.15.2
+scipy==1.15.3
     # via
     #   scippneutron
     #   scippnexus

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/basetest.txt

@@ -19,13 +19,13 @@ cycler==0.12.1
     # via matplotlib
 decorator==5.2.1
     # via ipython
-exceptiongroup==1.2.2
+exceptiongroup==1.3.0
     # via
     #   ipython
     #   pytest
 executing==2.2.0
     # via stack-data
-fonttools==4.57.0
+fonttools==4.58.0
     # via matplotlib
 idna==3.10
     # via requests
@@ -33,11 +33,11 @@ iniconfig==2.1.0
     # via pytest
 ipython==8.36.0
     # via ipywidgets
-ipywidgets==8.1.6
+ipywidgets==8.1.7
     # via -r basetest.in
 jedi==0.19.2
     # via ipython
-jupyterlab-widgets==3.0.14
+jupyterlab-widgets==3.0.15
     # via ipywidgets
 kiwisolver==1.4.8
     # via matplotlib
@@ -47,13 +47,13 @@ lazy-loader==0.4
     #   tof
 llvmlite==0.44.0
     # via numba
-matplotlib==3.10.1
+matplotlib==3.10.3
     # via plopp
 matplotlib-inline==0.1.7
     # via ipython
 numba==0.61.2
     # via -r basetest.in
-numpy==2.2.5
+numpy==2.2.6
     # via
     #   contourpy
     #   matplotlib
@@ -72,11 +72,11 @@ pexpect==4.9.0
     # via ipython
 pillow==11.2.1
     # via matplotlib
-platformdirs==4.3.7
+platformdirs==4.3.8
     # via pooch
 plopp==25.4.1
     # via tof
-pluggy==1.5.0
+pluggy==1.6.0
     # via pytest
 pooch==1.8.2
     # via -r basetest.in
@@ -98,7 +98,7 @@ requests==2.32.3
     # via pooch
 scipp==25.5.0
     # via tof
-scipy==1.15.2
+scipy==1.15.3
     # via
     #   -r basetest.in
     #   tof
@@ -117,7 +117,9 @@ traitlets==5.14.3
     #   ipywidgets
     #   matplotlib-inline
 typing-extensions==4.13.2
-    # via ipython
+    # via
+    #   exceptiongroup
+    #   ipython
 urllib3==2.4.0
     # via requests
 wcwidth==0.2.13

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/ci.txt

@@ -32,13 +32,13 @@ packaging==25.0
     #   -r ci.in
     #   pyproject-api
     #   tox
-platformdirs==4.3.7
+platformdirs==4.3.8
     # via
     #   tox
     #   virtualenv
-pluggy==1.5.0
+pluggy==1.6.0
     # via tox
-pyproject-api==1.9.0
+pyproject-api==1.9.1
     # via tox
 requests==2.32.3
     # via -r ci.in
@@ -48,11 +48,11 @@ tomli==2.2.1
     # via
     #   pyproject-api
     #   tox
-tox==4.25.0
+tox==4.26.0
     # via -r ci.in
 typing-extensions==4.13.2
     # via tox
 urllib3==2.4.0
     # via requests
-virtualenv==20.30.0
+virtualenv==20.31.2
     # via tox

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/dev.txt

@@ -26,13 +26,13 @@ async-lru==2.0.5
     # via jupyterlab
 cffi==1.17.1
     # via argon2-cffi-bindings
-click==8.1.8
+click==8.2.0
     # via
     #   pip-compile-multi
     #   pip-tools
 copier==9.7.1
     # via -r dev.in
-dunamai==1.23.1
+dunamai==1.24.1
     # via copier
 fqdn==1.5.1
     # via jsonschema
@@ -61,7 +61,7 @@ jupyter-events==0.12.0
     # via jupyter-server
 jupyter-lsp==2.2.5
     # via jupyterlab
-jupyter-server==2.15.0
+jupyter-server==2.16.0
     # via
     #   jupyter-lsp
     #   jupyterlab
@@ -69,7 +69,7 @@ jupyter-server==2.15.0
     #   notebook-shim
 jupyter-server-terminals==0.5.3
     # via jupyter-server
-jupyterlab==4.4.1
+jupyterlab==4.4.2
     # via -r dev.in
 jupyterlab-server==2.27.3
     # via jupyterlab
@@ -85,7 +85,7 @@ pip-tools==7.4.1
     # via pip-compile-multi
 plumbum==1.9.0
     # via copier
-prometheus-client==0.21.1
+prometheus-client==0.22.0
     # via jupyter-server
 pycparser==2.22
     # via cffi
@@ -111,7 +111,7 @@ terminado==0.18.1
     #   jupyter-server-terminals
 toposort==1.10
     # via pip-compile-multi
-types-python-dateutil==2.9.0.20241206
+types-python-dateutil==2.9.0.20250516
     # via arrow
 uri-template==1.3.0
     # via jsonschema

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/docs.in

@@ -3,6 +3,7 @@ ipykernel
 ipython!=8.7.0  # Breaks syntax highlighting in Jupyter code cells.
 myst-parser
 nbsphinx
+numba
 plopp
 pydata-sphinx-theme>=0.14
 sphinx

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/docs.txt

@@ -1,4 +1,4 @@
-# SHA1:de5c64b312f00d07eca11697a7756051987dfe90
+# SHA1:5205c7bf93f31f2c74209026f99d2e5496ed7adc
 #
 # This file was generated by pip-compile-multi.
 # To update, run:
@@ -10,8 +10,6 @@ accessible-pygments==0.0.5
     # via pydata-sphinx-theme
 alabaster==1.0.0
     # via sphinx
-appnope==0.1.4
-    # via ipykernel
 asttokens==3.0.0
     # via stack-data
 attrs==25.3.0
@@ -48,7 +46,7 @@ docutils==0.21.2
     #   nbsphinx
     #   pydata-sphinx-theme
     #   sphinx
-exceptiongroup==1.2.2
+exceptiongroup==1.3.0
     # via ipython
 executing==2.2.0
     # via stack-data
@@ -65,7 +63,7 @@ ipython==8.36.0
     #   -r docs.in
     #   ipykernel
     #   ipywidgets
-ipywidgets==8.1.6
+ipywidgets==8.1.7
     # via -r docs.in
 jedi==0.19.2
     # via ipython
@@ -92,8 +90,10 @@ jupyter-core==5.7.2
     #   nbformat
 jupyterlab-pygments==0.3.0
     # via nbconvert
-jupyterlab-widgets==3.0.14
+jupyterlab-widgets==3.0.15
     # via ipywidgets
+llvmlite==0.44.0
+    # via numba
 markdown-it-py==3.0.0
     # via
     #   mdit-py-plugins
@@ -127,13 +127,15 @@ nbsphinx==0.9.7
     # via -r docs.in
 nest-asyncio==1.6.0
     # via ipykernel
+numba==0.61.2
+    # via -r docs.in
 pandocfilters==1.5.1
     # via nbconvert
 parso==0.8.4
     # via jedi
 pexpect==4.9.0
     # via ipython
-platformdirs==4.3.7
+platformdirs==4.3.8
     # via jupyter-core
 prompt-toolkit==3.0.51
     # via ipython
@@ -164,11 +166,11 @@ referencing==0.36.2
     #   jsonschema-specifications
 requests==2.32.3
     # via sphinx
-rpds-py==0.24.0
+rpds-py==0.25.0
     # via
     #   jsonschema
     #   referencing
-snowballstemmer==2.2.0
+snowballstemmer==3.0.1
     # via sphinx
 soupsieve==2.7
     # via beautifulsoup4
@@ -207,7 +209,7 @@ tof==25.5.0
     # via -r docs.in
 tomli==2.2.1
     # via sphinx
-tornado==6.4.2
+tornado==6.5
     # via
     #   ipykernel
     #   jupyter-client

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/nightly.txt

@@ -32,13 +32,13 @@ dnspython==2.7.0
     # via email-validator
 email-validator==2.2.0
     # via scippneutron
-exceptiongroup==1.2.2
+exceptiongroup==1.3.0
     # via
     #   ipython
     #   pytest
 executing==2.2.0
     # via stack-data
-fonttools==4.57.0
+fonttools==4.58.0
     # via matplotlib
 h5py==3.13.0
     # via
@@ -52,11 +52,11 @@ iniconfig==2.1.0
     # via pytest
 ipython==8.36.0
     # via ipywidgets
-ipywidgets==8.1.6
+ipywidgets==8.1.7
     # via -r nightly.in
 jedi==0.19.2
     # via ipython
-jupyterlab-widgets==3.0.14
+jupyterlab-widgets==3.0.15
     # via ipywidgets
 kiwisolver==1.4.8
     # via matplotlib
@@ -67,7 +67,7 @@ lazy-loader==0.4
     #   tof
 llvmlite==0.44.0
     # via numba
-matplotlib==3.10.1
+matplotlib==3.10.3
     # via
     #   mpltoolbox
     #   plopp
@@ -79,7 +79,7 @@ networkx==3.4.2
     # via cyclebane
 numba==0.61.2
     # via -r nightly.in
-numpy==2.2.5
+numpy==2.2.6
     # via
     #   contourpy
     #   h5py
@@ -100,13 +100,13 @@ pexpect==4.9.0
     # via ipython
 pillow==11.2.1
     # via matplotlib
-platformdirs==4.3.7
+platformdirs==4.3.8
     # via pooch
 plopp==25.4.1
     # via
     #   scippneutron
     #   tof
-pluggy==1.5.0
+pluggy==1.6.0
     # via pytest
 pooch==1.8.2
     # via -r nightly.in
@@ -147,7 +147,7 @@ scippnexus @ git+https://github.com/scipp/scippnexus@main
     # via
     #   -r nightly.in
     #   scippneutron
-scipy==1.15.2
+scipy==1.15.3
     # via
     #   -r nightly.in
     #   scippneutron
@@ -169,6 +169,7 @@ traitlets==5.14.3
     #   matplotlib-inline
 typing-extensions==4.13.2
     # via
+    #   exceptiongroup
     #   ipython
     #   pydantic
     #   pydantic-core

{essreduce-25.5.1 → essreduce-25.5.3}/requirements/static.txt

@@ -15,11 +15,11 @@ identify==2.6.10
     # via pre-commit
 nodeenv==1.9.1
     # via pre-commit
-platformdirs==4.3.7
+platformdirs==4.3.8
     # via virtualenv
 pre-commit==4.2.0
     # via -r static.in
 pyyaml==6.0.2
     # via pre-commit
-virtualenv==20.30.0
+virtualenv==20.31.2
     # via pre-commit

{essreduce-25.5.1 → essreduce-25.5.3}/src/ess/reduce/data.py

@@ -40,6 +40,15 @@ _bifrost_registry = Registry(
 )
 
 
+_dream_registry = Registry(
+    instrument='dream',
+    files={
+        "TEST_977695_00068064.hdf": "md5:9e6ee9ec70d7c5e8c0c93b9e07e8949f",
+    },
+    version='2',
+)
+
+
 _loki_registry = Registry(
     instrument='loki',
     files={
@@ -94,3 +103,11 @@ def loki_tutorial_background_run_60393() -> str:
 def loki_tutorial_sample_transmission_run() -> str:
     """Sample transmission run (sample + sample holder/can + transmission monitor)."""
     return _loki_registry.get_path('60394-2022-02-28_2215.nxs')
+
+
+def dream_coda_test_file() -> str:
+    """CODA file for DREAM where most pulses have been removed.
+
+    See ``tools/shrink_nexus.py``.
+    """
+    return _dream_registry.get_path('TEST_977695_00068064.hdf')

{essreduce-25.5.1 → essreduce-25.5.3}/src/ess/reduce/nexus/types.py

@@ -8,6 +8,7 @@ import sciline
 import scipp as sc
 import scippnexus as snx
 from scippneutron import metadata as scn_meta
+from scippneutron.chopper import DiskChopper
 
 FilePath = NewType('FilePath', Path)
 """Full path to a NeXus file on disk."""
@@ -69,19 +70,13 @@ class TransmissionRun(Generic[ScatteringRunType]):
     """
 
 
-RunType = TypeVar(
-    'RunType',
-    BackgroundRun,
-    EmptyBeamRun,
-    SampleRun,
-    # Note that mypy does not seem to like this nesting, may need to find a workaround
-    TransmissionRun[SampleRun],
-    TransmissionRun[BackgroundRun],
-    VanadiumRun,
-)
+RunType = TypeVar('RunType')
 """TypeVar for specifying what run some data belongs to.
 
-Possible values:
+This type must be constrained when used in a Sciline pipeline.
+E.g., by passing ``run_types`` to :class:`ess.reduce.nexus.GenericNeXusWorkflow`.
+
+ESSreduce provides the following but custom types can be used:
 
 - :class:`BackgroundRun`
 - :class:`EmptyBeamRun`
@@ -92,58 +87,28 @@ Possible values:
 
 
 # 1.2  Monitor types
-Monitor1 = NewType('Monitor1', int)
-"""Identifier for an arbitrary monitor"""
-Monitor2 = NewType('Monitor2', int)
-"""Identifier for an arbitrary monitor"""
-Monitor3 = NewType('Monitor3', int)
-"""Identifier for an arbitrary monitor"""
-Monitor4 = NewType('Monitor4', int)
-"""Identifier for an arbitrary monitor"""
-Monitor5 = NewType('Monitor5', int)
-"""Identifier for an arbitrary monitor"""
-Monitor6 = NewType('Monitor6', int)
-"""Identifier for an arbitrary monitor"""
 IncidentMonitor = NewType('IncidentMonitor', int)
 """Incident monitor"""
 TransmissionMonitor = NewType('TransmissionMonitor', int)
 """Transmission monitor"""
-FrameMonitor0 = NewType('FrameMonitor', int)
+FrameMonitor0 = NewType('FrameMonitor0', int)
 """Frame monitor number 0"""
-FrameMonitor1 = NewType('FrameMonitor', int)
+FrameMonitor1 = NewType('FrameMonitor1', int)
 """Frame monitor number 1"""
-FrameMonitor2 = NewType('FrameMonitor', int)
+FrameMonitor2 = NewType('FrameMonitor2', int)
 """Frame monitor number 2"""
-FrameMonitor3 = NewType('FrameMonitor', int)
+FrameMonitor3 = NewType('FrameMonitor3', int)
 """Frame monitor number 3"""
 CaveMonitor = NewType('CaveMonitor', int)
 """A monitor located in the instrument cave"""
-MonitorType = TypeVar(
-    'MonitorType',
-    Monitor1,
-    Monitor2,
-    Monitor3,
-    Monitor4,
-    Monitor5,
-    Monitor6,
-    IncidentMonitor,
-    TransmissionMonitor,
-    FrameMonitor0,
-    FrameMonitor1,
-    FrameMonitor2,
-    FrameMonitor3,
-    CaveMonitor,
-)
+MonitorType = TypeVar('MonitorType')
 """TypeVar for specifying what monitor some data belongs to.
 
-Possible values:
+This type must be constrained when used in a Sciline pipeline.
+E.g., by passing ``monitor_types`` to :class:`ess.reduce.nexus.GenericNeXusWorkflow`.
+
+ESSreduce provides the following but custom types can be used:
 
-- :class:`Monitor1`
-- :class:`Monitor2`
-- :class:`Monitor3`
-- :class:`Monitor4`
-- :class:`Monitor5`
-- :class:`Monitor6`
 - :class:`IncidentMonitor`
 - :class:`TransmissionMonitor`
 - :class:`FrameMonitor0`
@@ -154,27 +119,20 @@ Possible values:
 """
 
 
-Component = TypeVar(
-    'Component',
+Component = TypeVar('Component')
+"""A beamline component in a neXus file."""
+COMPONENT_CONSTRAINTS = (
     snx.NXdetector,
     snx.NXsample,
     snx.NXsource,
     snx.NXdisk_chopper,
     snx.NXcrystal,
-    Monitor1,
-    Monitor2,
-    Monitor3,
-    Monitor4,
-    Monitor5,
-    Monitor6,
-    IncidentMonitor,
-    TransmissionMonitor,
-    FrameMonitor0,
-    FrameMonitor1,
-    FrameMonitor2,
-    FrameMonitor3,
-    CaveMonitor,
 )
+"""Base constraints for the Component type variable.
+
+This list will be supplemented with monitor types when creating a pipeline.
+"""
+
 UniqueComponent = TypeVar('UniqueComponent', snx.NXsample, snx.NXsource)
 """Components that can be identified by their type as there will only be one."""
 
@@ -336,8 +294,15 @@ class NeXusTransformation(Generic[Component, RunType]):
         return NeXusTransformation(value=transform)
 
 
-class Choppers(
+class RawChoppers(
     sciline.Scope[RunType, sc.DataGroup[sc.DataGroup[Any]]],
     sc.DataGroup[sc.DataGroup[Any]],
 ):
     """All choppers in a NeXus file."""
+
+
+class DiskChoppers(
+    sciline.Scope[RunType, sc.DataGroup[DiskChopper]],
+    sc.DataGroup[DiskChopper],
+):
+    """All disk choppers parsed from a NeXus file."""