essreduce 25.2.3__py3-none-any.whl → 25.2.5__py3-none-any.whl

ess/reduce/nexus/_nexus_loader.py

@@ -8,14 +8,16 @@ from collections.abc import Generator, Mapping
 from contextlib import AbstractContextManager, contextmanager, nullcontext
 from dataclasses import dataclass
 from math import prod
-from typing import cast
+from typing import TypeVar, cast
 
 import scipp as sc
 import scippnexus as snx
 
 from ..logging import get_logger
 from .types import (
+    Beamline,
     FilePath,
+    Measurement,
     NeXusAllLocationSpec,
     NeXusEntryName,
     NeXusFile,
@@ -27,6 +29,8 @@ from .types import (
 class NoNewDefinitionsType: ...
 
 
+_Model = TypeVar('_Model', Beamline, Measurement)
+
 NoNewDefinitions = NoNewDefinitionsType()
 
 
@@ -74,6 +78,18 @@ def load_all_components(
     return components
 
 
+def load_metadata(
+    file_path: FilePath | NeXusFile | NeXusGroup,
+    model: type[_Model],
+    *,
+    entry_name: NeXusEntryName | None = None,
+    definitions: Mapping | NoNewDefinitionsType = NoNewDefinitions,
+) -> _Model:
+    with _open_nexus_file(file_path, definitions=definitions) as f:
+        entry = _unique_child_group(f, snx.NXentry, entry_name)
+        return model.from_nexus_entry(entry)
+
+
 def compute_component_position(dg: sc.DataGroup) -> sc.DataGroup:
     # In some downstream packages we use some of the Nexus components which attempt
     # to compute positions without having actual Nexus data defining depends_on chains.
@@ -164,10 +180,15 @@ def _attempt_to_open_without_locking(
     # HDF5 tracks file locking flags internally within a single process.
     # If the same file is opened multiple times, we can get a flag mismatch.
     # We can try opening without locking, maybe this matches the original flags.
-    if "file locking flag values don't match" in err.args[0]:
-        return True
-    if "file locking 'ignore disabled locks' flag values don't match" in err.args[0]:
-        return True
+    error_message = err.args[0]
+    if isinstance(error_message, str):
+        if "file locking flag values don't match" in error_message:
+            return True
+        if (
+            "file locking 'ignore disabled locks' flag values don't match"
+            in error_message
+        ):
+            return True
     return False
 
 

ess/reduce/nexus/types.py

@@ -7,6 +7,7 @@ from typing import Any, BinaryIO, Generic, NewType, TypeVar
 import sciline
 import scipp as sc
 import scippnexus as snx
+from scippneutron import metadata as scn_meta
 
 FilePath = NewType('FilePath', Path)
 """Full path to a NeXus file on disk."""
@@ -177,6 +178,13 @@ Component = TypeVar(
 UniqueComponent = TypeVar('UniqueComponent', snx.NXsample, snx.NXsource)
 """Components that can be identified by their type as there will only be one."""
 
+Beamline = scn_meta.Beamline
+"""Beamline metadata."""
+Measurement = scn_meta.Measurement
+"""measurement metadata."""
+Source = scn_meta.Source
+"""Neutron source metadata."""
+
 
 class NeXusName(sciline.Scope[Component, str], str):
     """Name of a component in a NeXus file."""

ess/reduce/nexus/workflow.py

@@ -19,6 +19,7 @@ from . import _nexus_loader as nexus
 from .types import (
     AllNeXusComponents,
     Analyzers,
+    Beamline,
     CalibratedBeamline,
     CalibratedDetector,
     CalibratedMonitor,
@@ -29,6 +30,7 @@ from .types import (
     DetectorPositionOffset,
     Filename,
     GravityVector,
+    Measurement,
     MonitorData,
     MonitorPositionOffset,
     MonitorType,
@@ -45,6 +47,7 @@ from .types import (
     Position,
     PreopenNeXusFile,
     RunType,
+    SampleRun,
     TimeInterval,
     UniqueComponent,
 )
@@ -586,6 +589,18 @@ def _add_variances(da: sc.DataArray) -> sc.DataArray:
     return out
 
 
+def load_beamline_metadata_from_nexus(file_spec: NeXusFileSpec[SampleRun]) -> Beamline:
+    """Load beamline metadata from a sample NeXus file."""
+    return nexus.load_metadata(file_spec.value, Beamline)
+
+
+def load_measurement_metadata_from_nexus(
+    file_spec: NeXusFileSpec[SampleRun],
+) -> Measurement:
+    """Load measurement metadata from a sample NeXus file."""
+    return nexus.load_metadata(file_spec.value, Measurement)
+
+
 definitions = snx.base_definitions()
 definitions["NXdetector"] = _StrippedDetector
 definitions["NXmonitor"] = _StrippedMonitor
@@ -631,6 +646,11 @@ _chopper_providers = (parse_disk_choppers,)
 
 _analyzer_providers = (parse_analyzers,)
 
+_metadata_providers = (
+    load_beamline_metadata_from_nexus,
+    load_measurement_metadata_from_nexus,
+)
+
 
 def LoadMonitorWorkflow() -> sciline.Pipeline:
     """Generic workflow for loading monitor data from a NeXus file."""
@@ -689,6 +709,7 @@ def GenericNeXusWorkflow(
             *_detector_providers,
             *_chopper_providers,
             *_analyzer_providers,
+            *_metadata_providers,
         )
     )
     wf[DetectorBankSizes] = DetectorBankSizes({})

ess/reduce/streaming.py

@@ -68,7 +68,18 @@ class Accumulator(ABC, Generic[T]):
     def _do_push(self, value: T) -> None: ...
 
     @property
-    @abstractmethod
+    def is_empty(self) -> bool:
+        """
+        Check if the accumulator is empty.
+
+        Returns
+        -------
+        :
+            True if the accumulator is empty, False otherwise.
+        """
+        return False
+
+    @property
     def value(self) -> T:
         """
         Get the accumulated value.
@@ -77,6 +88,24 @@ class Accumulator(ABC, Generic[T]):
         -------
         :
             Accumulated value.
+
+        Raises
+        ------
+        ValueError
+            If the accumulator is empty.
+        """
+        if self.is_empty:
+            raise ValueError("Cannot get value from empty accumulator")
+        return self._get_value()
+
+    @abstractmethod
+    def _get_value(self) -> T:
+        """Return the accumulated value, assuming it exists."""
+
+    @abstractmethod
+    def clear(self) -> None:
+        """
+        Clear the accumulator, resetting it to its initial state.
         """
 
 
@@ -92,7 +121,10 @@ class EternalAccumulator(Accumulator[T]):
         self._value: T | None = None
 
     @property
-    def value(self) -> T:
+    def is_empty(self) -> bool:
+        return self._value is None
+
+    def _get_value(self) -> T:
         return deepcopy(self._value)
 
     def _do_push(self, value: T) -> None:
@@ -101,6 +133,10 @@ class EternalAccumulator(Accumulator[T]):
         else:
             self._value += value
 
+    def clear(self) -> None:
+        """Clear the accumulated value."""
+        self._value = None
+
 
 class RollingAccumulator(Accumulator[T]):
     """
@@ -121,7 +157,10 @@ class RollingAccumulator(Accumulator[T]):
         self._values: list[T] = []
 
     @property
-    def value(self) -> T:
+    def is_empty(self) -> bool:
+        return len(self._values) == 0
+
+    def _get_value(self) -> T:
         # Naive and potentially slow implementation if values and/or window are large!
         return sc.reduce(self._values).sum()
 
@@ -130,6 +169,10 @@ class RollingAccumulator(Accumulator[T]):
         if len(self._values) > self._window:
             self._values.pop(0)
 
+    def clear(self) -> None:
+        """Clear the accumulated values."""
+        self._values = []
+
 
 class StreamProcessor:
     """
@@ -299,6 +342,16 @@ class StreamProcessor:
             self._finalize_workflow[key] = self._accumulators[key].value
         return self._finalize_workflow.compute(self._target_keys)
 
+    def clear(self) -> None:
+        """
+        Clear all accumulators, resetting them to their initial state.
+
+        This is useful for restarting a streaming computation without
+        creating a new StreamProcessor instance.
+        """
+        for accumulator in self._accumulators.values():
+            accumulator.clear()
+
 
 def _find_descendants(
     workflow: sciline.Pipeline, keys: tuple[sciline.typing.Key, ...]

{essreduce-25.2.3.dist-info → essreduce-25.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: essreduce
-Version: 25.2.3
+Version: 25.2.5
 Summary: Common data reduction tools for the ESS facility
 Author: Scipp contributors
 License: BSD 3-Clause License
@@ -53,7 +53,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: sciline>=24.06.2
 Requires-Dist: scipp>=25.01.0
-Requires-Dist: scippneutron>=24.11.0
+Requires-Dist: scippneutron>=25.02.0
 Requires-Dist: scippnexus>=24.11.0
 Provides-Extra: test
 Requires-Dist: ipywidgets; extra == "test"

{essreduce-25.2.3.dist-info → essreduce-25.2.5.dist-info}/RECORD

@@ -3,7 +3,7 @@ ess/reduce/data.py,sha256=vaoeAJ6EpK1YghOiAALLdWiW17TgUnnnt0H-RGiGzXk,3756
 ess/reduce/logging.py,sha256=6n8Czq4LZ3OK9ENlKsWSI1M3KvKv6_HSoUiV4__IUlU,357
 ess/reduce/parameter.py,sha256=4sCfoKOI2HuO_Q7JLH_jAXnEOFANSn5P3NdaOBzhJxc,4635
 ess/reduce/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ess/reduce/streaming.py,sha256=ffFiWpq9AK1GOfRG-rlvT_Gz7HMBnE4FD0qPZiej4Gg,10306
+ess/reduce/streaming.py,sha256=XNUr5Vg8lufBqjTjjzd0nfiRR2f70zkTixXkG_O26Bk,11687
 ess/reduce/ui.py,sha256=zmorAbDwX1cU3ygDT--OP58o0qU7OBcmJz03jPeYSLA,10884
 ess/reduce/uncertainty.py,sha256=LR4O6ApB6Z-W9gC_XW0ajupl8yFG-du0eee1AX_R-gk,6990
 ess/reduce/workflow.py,sha256=sL34T_2Cjl_8iFlegujxI9VyOUwo6erVC8pOXnfWgYw,3060
@@ -12,11 +12,11 @@ ess/reduce/live/raw.py,sha256=pzXsPZQERtUm5tabTXjxd-XHH4WDDP13TTBG0lGPcqg,25262
 ess/reduce/live/roi.py,sha256=Hs-pW98k41WU6Kl3UQ41kQawk80c2QNOQ_WNctLzDPE,3795
 ess/reduce/live/workflow.py,sha256=bsbwvTqPhRO6mC__3b7MgU7DWwAnOvGvG-t2n22EKq8,4285
 ess/reduce/nexus/__init__.py,sha256=59bxKkNYg8DYcSykNvH6nCa5SYchJC4SbgZEKhkNdYc,967
-ess/reduce/nexus/_nexus_loader.py,sha256=NbKIepTxv-UirVlViImh8Ozm16k-ZIiF6AQ9-oKuDHU,19222
+ess/reduce/nexus/_nexus_loader.py,sha256=NpBTBjWLKSnW0B1EarFdt2QxV0X7QBQLk2dSJq2ZuOw,19847
 ess/reduce/nexus/json_generator.py,sha256=ME2Xn8L7Oi3uHJk9ZZdCRQTRX-OV_wh9-DJn07Alplk,2529
 ess/reduce/nexus/json_nexus.py,sha256=QrVc0p424nZ5dHX9gebAJppTw6lGZq9404P_OFl1giA,10282
-ess/reduce/nexus/types.py,sha256=Az_pZtaTIlEAA4Po_YOLabez8w4HeHcr0asY3rS6BXg,9676
-ess/reduce/nexus/workflow.py,sha256=jzdh0ubp9Mmb98a04KIeM8Xo9bpAqpnsfwFWz2VllnQ,23676
+ess/reduce/nexus/types.py,sha256=15XcHbNbOfnAYjWXzzKyYDVNyNixRnP0hJ-Q2duwMWE,9896
+ess/reduce/nexus/workflow.py,sha256=ABVc9E1Qcos0wLcDE8bGDAOz3aPpHrj4TJyfHsQbx7I,24297
 ess/reduce/scripts/grow_nexus.py,sha256=hET3h06M0xlJd62E3palNLFvJMyNax2kK4XyJcOhl-I,3387
 ess/reduce/time_of_flight/__init__.py,sha256=92w88NpGIBysuqCPSvdZ_XgBd7cFAk9qaO9zflpUbfM,1097
 ess/reduce/time_of_flight/fakes.py,sha256=rlBgceFVbHIhP_xPyUzYVf-2wEu--G8hA-kxPzAnPbM,4236
@@ -36,9 +36,9 @@ ess/reduce/widgets/_spinner.py,sha256=2VY4Fhfa7HMXox2O7UbofcdKsYG-AJGrsgGJB85nDX
 ess/reduce/widgets/_string_widget.py,sha256=iPAdfANyXHf-nkfhgkyH6gQDklia0LebLTmwi3m-iYQ,1482
 ess/reduce/widgets/_switchable_widget.py,sha256=fjKz99SKLhIF1BLgGVBSKKn3Lu_jYBwDYGeAjbJY3Q8,2390
 ess/reduce/widgets/_vector_widget.py,sha256=aTaBqCFHZQhrIoX6-sSqFWCPePEW8HQt5kUio8jP1t8,1203
-essreduce-25.2.3.dist-info/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
-essreduce-25.2.3.dist-info/METADATA,sha256=aKumfO4ID_7M42EvaeTFiVAW2acxYhi0--N7E4U9lfY,3708
-essreduce-25.2.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-essreduce-25.2.3.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
-essreduce-25.2.3.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
-essreduce-25.2.3.dist-info/RECORD,,
+essreduce-25.2.5.dist-info/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
+essreduce-25.2.5.dist-info/METADATA,sha256=ri1OfgsTeyU-LR2NMBoAB5zJXLCRAl72qkND7TbOf5M,3708
+essreduce-25.2.5.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+essreduce-25.2.5.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
+essreduce-25.2.5.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
+essreduce-25.2.5.dist-info/RECORD,,

{essreduce-25.2.3.dist-info → essreduce-25.2.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any