Merge pull request #165 from scipp/custom-type-var-constraints

jl-wynen · web-flow · commit 8d97af98e8dd · 2025-05-22T13:15:35.000+02:00
Custom type var constraints
diff --git a/docs/user-guide/dream/dream-advanced-powder-reduction.ipynb b/docs/user-guide/dream/dream-advanced-powder-reduction.ipynb
@@ -56,12 +56,12 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[MonitorFilename[SampleRun]] = dream.data.simulated_monitor_diamond_sample()\n",
     "workflow[MonitorFilename[VanadiumRun]] = dream.data.simulated_monitor_vanadium_sample()\n",
-    "workflow[MonitorFilename[BackgroundRun]] = dream.data.simulated_monitor_empty_can()\n",
+    "workflow[MonitorFilename[EmptyCanRun]] = dream.data.simulated_monitor_empty_can()\n",
     "workflow[CaveMonitorPosition] = sc.vector([0.0, 0.0, -4220.0], unit=\"mm\")\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
@@ -174,12 +174,12 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[MonitorFilename[SampleRun]] = dream.data.simulated_monitor_diamond_sample()\n",
     "workflow[MonitorFilename[VanadiumRun]] = dream.data.simulated_monitor_vanadium_sample()\n",
-    "workflow[MonitorFilename[BackgroundRun]] = dream.data.simulated_monitor_empty_can()\n",
+    "workflow[MonitorFilename[EmptyCanRun]] = dream.data.simulated_monitor_empty_can()\n",
     "workflow[CaveMonitorPosition] = sc.vector([0.0, 0.0, -4220.0], unit=\"mm\")\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
@@ -254,7 +254,7 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
@@ -374,7 +374,7 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
diff --git a/docs/user-guide/dream/dream-powder-reduction.ipynb b/docs/user-guide/dream/dream-powder-reduction.ipynb
@@ -79,12 +79,12 @@
    "source": [
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[MonitorFilename[SampleRun]] = dream.data.simulated_monitor_diamond_sample()\n",
     "workflow[MonitorFilename[VanadiumRun]] = dream.data.simulated_monitor_vanadium_sample()\n",
-    "workflow[MonitorFilename[BackgroundRun]] = dream.data.simulated_monitor_empty_can()\n",
+    "workflow[MonitorFilename[EmptyCanRun]] = dream.data.simulated_monitor_empty_can()\n",
     "workflow[CaveMonitorPosition] = sc.vector([0.0, 0.0, -4220.0], unit=\"mm\")\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,7 +32,7 @@ requires-python = ">=3.10"
 # Make sure to list one dependency per line.
 dependencies = [
   "dask",
-  "essreduce>=25.05.1",
+  "essreduce>=25.05.2",
   "graphviz",
   "numpy",
   "plopp>=25.03.0",
diff --git a/requirements/base.in b/requirements/base.in
@@ -3,7 +3,7 @@
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
 dask
-essreduce>=25.05.1
+essreduce>=25.05.2
 graphviz
 numpy
 plopp>=25.03.0
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -1,4 +1,4 @@
-# SHA1:9fd92aa14a70d874a87640e7dbb332600b0c2ac7
+# SHA1:60cb3370153cfec27ffbe68c100df7aa10faaed0
 #
 # This file was generated by pip-compile-multi.
 # To update, run:
@@ -9,7 +9,7 @@ annotated-types==0.7.0
     # via pydantic
 asttokens==3.0.0
     # via stack-data
-click==8.2.0
+click==8.2.1
     # via dask
 cloudpickle==3.1.1
     # via dask
@@ -21,23 +21,23 @@ cyclebane==24.10.0
     # via sciline
 cycler==0.12.1
     # via matplotlib
-dask==2025.5.0
+dask==2025.5.1
     # via -r base.in
 decorator==5.2.1
     # via ipython
 dnspython==2.7.0
     # via email-validator
 email-validator==2.2.0
     # via scippneutron
-essreduce==25.5.1
+essreduce==25.5.2
     # via -r base.in
 exceptiongroup==1.3.0
     # via ipython
 executing==2.2.0
     # via stack-data
 fonttools==4.58.0
     # via matplotlib
-fsspec==2025.3.2
+fsspec==2025.5.0
     # via dask
 graphviz==0.20.3
     # via -r base.in
@@ -80,7 +80,7 @@ mpltoolbox==25.4.0
     # via scippneutron
 networkx==3.4.2
     # via cyclebane
-numpy==2.2.5
+numpy==2.2.6
     # via
     #   -r base.in
     #   contourpy
@@ -104,7 +104,7 @@ pexpect==4.9.0
     # via ipython
 pillow==11.2.1
     # via matplotlib
-plopp==25.4.1
+plopp==25.5.0
     # via
     #   -r base.in
     #   scippneutron
@@ -132,7 +132,7 @@ pythreejs==2.4.2
     # via -r base.in
 pyyaml==6.0.2
     # via dask
-sciline==25.5.1
+sciline==25.5.2
     # via
     #   -r base.in
     #   essreduce
@@ -185,7 +185,7 @@ typing-extensions==4.13.2
     #   pydantic-core
     #   sciline
     #   typing-inspection
-typing-inspection==0.4.0
+typing-inspection==0.4.1
     # via pydantic
 wcwidth==0.2.13
     # via prompt-toolkit
diff --git a/requirements/basetest.txt b/requirements/basetest.txt
@@ -15,7 +15,7 @@ idna==3.10
     # via requests
 iniconfig==2.1.0
     # via pytest
-numpy==2.2.5
+numpy==2.2.6
     # via pandas
 packaging==25.0
     # via
@@ -25,7 +25,7 @@ pandas==2.2.3
     # via -r basetest.in
 platformdirs==4.3.8
     # via pooch
-pluggy==1.5.0
+pluggy==1.6.0
     # via pytest
 pooch==1.8.2
     # via -r basetest.in
diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -36,7 +36,7 @@ platformdirs==4.3.8
     # via
     #   tox
     #   virtualenv
-pluggy==1.5.0
+pluggy==1.6.0
     # via tox
 pyproject-api==1.9.1
     # via tox
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -81,7 +81,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
@@ -107,7 +107,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
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -138,7 +138,7 @@ requests==2.32.3
     # via
     #   pooch
     #   sphinx
-rpds-py==0.24.0
+rpds-py==0.25.1
     # via
     #   jsonschema
     #   referencing
@@ -180,7 +180,7 @@ tinycss2==1.4.0
     # via bleach
 tomli==2.2.1
     # via sphinx
-tornado==6.4.2
+tornado==6.5
     # via
     #   ipykernel
     #   jupyter-client
diff --git a/requirements/nightly.txt b/requirements/nightly.txt
@@ -16,7 +16,7 @@ certifi==2025.4.26
     # via requests
 charset-normalizer==3.4.2
     # via requests
-click==8.2.0
+click==8.2.1
     # via dask
 cloudpickle==3.1.1
     # via dask
@@ -28,7 +28,7 @@ cyclebane==24.10.0
     # via sciline
 cycler==0.12.1
     # via matplotlib
-dask==2025.5.0
+dask==2025.5.1
     # via -r nightly.in
 decorator==5.2.1
     # via ipython
@@ -46,7 +46,7 @@ executing==2.2.0
     # via stack-data
 fonttools==4.58.0
     # via matplotlib
-fsspec==2025.3.2
+fsspec==2025.5.0
     # via dask
 graphviz==0.20.3
     # via -r nightly.in
@@ -93,7 +93,7 @@ mpltoolbox==25.4.0
     # via scippneutron
 networkx==3.4.2
     # via cyclebane
-numpy==2.2.5
+numpy==2.2.6
     # via
     #   -r nightly.in
     #   contourpy
@@ -129,7 +129,7 @@ plopp @ git+https://github.com/scipp/plopp@main
     #   -r nightly.in
     #   scippneutron
     #   tof
-pluggy==1.5.0
+pluggy==1.6.0
     # via pytest
 pooch==1.8.2
     # via -r nightly.in
@@ -218,7 +218,7 @@ typing-extensions==4.13.2
     #   pydantic-core
     #   sciline
     #   typing-inspection
-typing-inspection==0.4.0
+typing-inspection==0.4.1
     # via pydantic
 tzdata==2025.2
     # via pandas
diff --git a/src/ess/dream/io/cif.py b/src/ess/dream/io/cif.py
@@ -14,7 +14,7 @@
     IofTof,
     ReducedEmptyCanSubtractedTofCIF,
     ReducedTofCIF,
-    ReducerSoftwares,
+    ReducerSoftware,
     Source,
 )
 
@@ -25,7 +25,7 @@ def prepare_reduced_tof_cif(
     authors: CIFAuthors,
     beamline: Beamline,
     source: Source,
-    reducers: ReducerSoftwares,
+    reducers: ReducerSoftware,
     calibration: OutputCalibrationData,
 ) -> ReducedTofCIF:
     """Construct a CIF builder with reduced data in d-spacing.
@@ -71,7 +71,7 @@ def prepare_reduced_empty_can_subtracted_tof_cif(
     authors: CIFAuthors,
     beamline: Beamline,
     source: Source,
-    reducers: ReducerSoftwares,
+    reducers: ReducerSoftware,
     calibration: OutputCalibrationData,
 ) -> ReducedEmptyCanSubtractedTofCIF:
     """Construct a CIF builder with reduced data in d-spacing.
@@ -117,7 +117,7 @@ def _prepare_reduced_tof_cif_impl(
     authors: CIFAuthors,
     beamline: Beamline,
     source: Source,
-    reducers: ReducerSoftwares,
+    reducers: ReducerSoftware,
     calibration: OutputCalibrationData,
 ) -> ReducedTofCIF:
     to_save = _prepare_data(da)
diff --git a/src/ess/dream/io/geant4.py b/src/ess/dream/io/geant4.py
@@ -8,7 +8,6 @@
 from scippneutron.metadata import ESS_SOURCE
 
 from ess.powder.types import (
-    BackgroundRun,
     Beamline,
     CalibratedBeamline,
     CalibratedDetector,
@@ -18,6 +17,7 @@
     CaveMonitor,
     CaveMonitorPosition,
     DetectorData,
+    EmptyCanRun,
     Filename,
     MonitorData,
     MonitorFilename,
@@ -321,7 +321,7 @@ def LoadGeant4Workflow() -> sciline.Pipeline:
     Workflow for loading NeXus data.
     """
     wf = GenericTofWorkflow(
-        run_types=[SampleRun, VanadiumRun, BackgroundRun], monitor_types=[CaveMonitor]
+        run_types=[SampleRun, VanadiumRun, EmptyCanRun], monitor_types=[CaveMonitor]
     )
     wf.insert(extract_geant4_detector)
     wf.insert(load_geant4_csv)
diff --git a/src/ess/dream/io/nexus.py b/src/ess/dream/io/nexus.py
@@ -15,7 +15,13 @@
 
 import sciline
 
-from ess.powder.types import BunkerMonitor, CaveMonitor
+from ess.powder.types import (
+    BunkerMonitor,
+    CaveMonitor,
+    EmptyCanRun,
+    SampleRun,
+    VanadiumRun,
+)
 from ess.reduce.nexus.types import DetectorBankSizes, NeXusName
 from ess.reduce.nexus.workflow import GenericNeXusWorkflow
 
@@ -50,7 +56,10 @@ def LoadNeXusWorkflow() -> sciline.Pipeline:
     """
     Workflow for loading NeXus data.
     """
-    wf = GenericNeXusWorkflow()
+    wf = GenericNeXusWorkflow(
+        run_types=(SampleRun, VanadiumRun, EmptyCanRun),
+        monitor_types=(BunkerMonitor, CaveMonitor),
+    )
     wf[DetectorBankSizes] = DETECTOR_BANK_SIZES
     wf[NeXusName[BunkerMonitor]] = "monitor_bunker"
     wf[NeXusName[CaveMonitor]] = "monitor_cave"
diff --git a/src/ess/dream/parameters.py b/src/ess/dream/parameters.py
@@ -5,9 +5,9 @@
 from __future__ import annotations
 
 from ess.powder.types import (
-    BackgroundRun,
     CalibrationFilename,
     DspacingBins,
+    EmptyCanRun,
     Filename,
     IofDspacing,
     IofDspacingTwoTheta,
@@ -36,8 +36,8 @@
 parameter_registry[Filename[VanadiumRun]] = FilenameParameter.from_type(
     Filename[VanadiumRun]
 )
-parameter_registry[Filename[BackgroundRun]] = FilenameParameter.from_type(
-    Filename[BackgroundRun]
+parameter_registry[Filename[EmptyCanRun]] = FilenameParameter.from_type(
+    Filename[EmptyCanRun]
 )
 parameter_registry[CalibrationFilename] = FilenameParameter.from_type(
     CalibrationFilename
diff --git a/src/ess/dream/workflow.py b/src/ess/dream/workflow.py
diff --git a/src/ess/powder/correction.py b/src/ess/powder/correction.py
diff --git a/src/ess/powder/types.py b/src/ess/powder/types.py
diff --git a/tests/dream/geant4_reduction_test.py b/tests/dream/geant4_reduction_test.py
diff --git a/tests/dream/io/cif_test.py b/tests/dream/io/cif_test.py
diff --git a/tests/dream/io/nexus_test.py b/tests/dream/io/nexus_test.py
diff --git a/tools/docs/dream-thumbnails.ipynb b/tools/docs/dream-thumbnails.ipynb
