essreduce 25.10.1__py3-none-any.whl → 25.10.2__py3-none-any.whl

ess/reduce/nexus/__init__.py

@@ -20,6 +20,8 @@ from ._nexus_loader import (
     load_all_components,
     load_component,
     load_data,
+    open_component_group,
+    open_nexus_file,
 )
 from .workflow import GenericNeXusWorkflow
 
@@ -31,5 +33,7 @@ __all__ = [
     'load_all_components',
     'load_component',
     'load_data',
+    'open_component_group',
+    'open_nexus_file',
     'types',
 ]

ess/reduce/nexus/_nexus_loader.py

@@ -46,17 +46,37 @@ def load_component(
     location: NeXusLocationSpec,
     *,
     nx_class: type[snx.NXobject],
+    parent_class: type[snx.NXobject] | None = None,
     definitions: Mapping | None | NoNewDefinitionsType = NoNewDefinitions,
 ) -> sc.DataGroup:
-    """Load a single component of a given class from NeXus."""
+    """Load a single component of a given class from NeXus.
+
+    Parameters
+    ----------
+    location:
+        Specifies (part of) the location of the component to load.
+    nx_class:
+        NeXus class of the component to load.
+    parent_class:
+        NeXus class of the parent of the component to load.
+        If ``None``, is deduced from ``nx_class`` if possible.
+    definitions:
+        Application definitions to use for the file.
+
+    Returns
+    -------
+    :
+        The loaded component as a data group.
+    """
     selection = location.selection
-    group_name = location.component_name
-    with _open_component_parent(
-        location, nx_class=nx_class, definitions=definitions
-    ) as parent:
-        component = _unique_child_group(parent, nx_class, group_name)
-        loaded = cast(sc.DataGroup, component[selection])
-        loaded['nexus_component_name'] = component.name.rsplit('/', 1)[-1]
+    with open_component_group(
+        location,
+        nx_class=nx_class,
+        parent_class=parent_class,
+        definitions=definitions,
+    ) as group:
+        loaded = cast(sc.DataGroup, group[selection])
+        loaded['nexus_component_name'] = group.name.rsplit('/', 1)[-1]
     return loaded
 
 
@@ -64,11 +84,14 @@ def load_all_components(
     location: NeXusAllLocationSpec,
     *,
     nx_class: type[snx.NXobject],
+    parent_class: type[snx.NXobject] | None = None,
     definitions: Mapping | None | NoNewDefinitionsType = NoNewDefinitions,
 ) -> sc.DataGroup:
     """Load all components of a given class from NeXus."""
     with _open_component_parent(
-        location, nx_class=nx_class, definitions=definitions
+        location,
+        parent_class=_deduce_component_parent_class(nx_class, parent_class),
+        definitions=definitions,
     ) as parent:
         components = sc.DataGroup()
         for name, component in parent[nx_class].items():
@@ -119,6 +142,29 @@ def open_nexus_file(
     *,
     locking: bool | str | None | NoLockingIfNeededType = NoLockingIfNeeded,
 ) -> AbstractContextManager[snx.Group]:
+    """Open a NeXus file.
+
+    Parameters
+    ----------
+    file_path:
+        Path of the file to open or a NeXus file or group handle.
+    definitions:
+        If set, application definitions to use for the file.
+        If ``file_path`` is a NeXus file or group, this must be unset or match
+        the existing definitions.
+    locking:
+        This is an advanced feature to work around a limitation of the DMSC file system.
+        It may be removed in the future.
+
+        This flag can disable or force locking the HDF5 file.
+        By default, the file is locked if possible but may remain unlocked
+        if it is on a read-only filesystem.
+
+    Returns
+    -------
+    :
+        A context manager for the opened file.
+    """
     if isinstance(file_path, getattr(NeXusGroup, '__supertype__', type(None))):
         if (
             definitions is not NoNewDefinitions
@@ -203,10 +249,46 @@ def _open_nexus_file_from_path(
 
 
 @contextmanager
-def _open_component_parent(
+def open_component_group(
     location: NeXusLocationSpec,
     *,
     nx_class: type[snx.NXobject],
+    parent_class: type[snx.NXobject] | None = None,
+    definitions: Mapping | None | NoNewDefinitionsType = NoNewDefinitions,
+) -> Generator[snx.Group, None, None]:
+    """Open the HDF5 group of a NeXus component.
+
+    Parameters
+    ----------
+    location:
+        Specifies (part of) the location of the component to load.
+    nx_class:
+        NeXus class of the component to load.
+    parent_class:
+        NeXus class of the parent of the component to load.
+        If ``None``, is deduced from ``nx_class`` if possible.
+    definitions:
+        Application definitions to use for the file.
+
+    Returns
+    -------
+    :
+        A context manager for the group of the specified component.
+    """
+    group_name = location.component_name
+    with _open_component_parent(
+        location,
+        parent_class=_deduce_component_parent_class(nx_class, parent_class),
+        definitions=definitions,
+    ) as parent:
+        yield _unique_child_group(parent, nx_class, group_name)
+
+
+@contextmanager
+def _open_component_parent(
+    location: NeXusLocationSpec,
+    *,
+    parent_class: type[snx.NXobject],
     definitions: Mapping | None | NoNewDefinitionsType = NoNewDefinitions,
 ) -> Generator[snx.Group, None, None]:
     """Locate the parent group of a NeXus component."""
@@ -214,10 +296,30 @@ def _open_component_parent(
     entry_name = location.entry_name
     with open_nexus_file(file_path, definitions=definitions) as f:
         entry = _unique_child_group(f, snx.NXentry, entry_name)
-        if nx_class is snx.NXsample:
-            yield entry
-        else:
-            yield _unique_child_group(entry, snx.NXinstrument, None)
+        match parent_class:
+            case snx.NXentry:
+                yield entry
+            case snx.NXinstrument:
+                yield _unique_child_group(entry, snx.NXinstrument, None)
+            case _:
+                raise NotImplementedError(
+                    f"No support for loading a NeXus component from a {parent_class}."
+                )
+
+
+def _deduce_component_parent_class(
+    nx_class: type[snx.NXobject], parent_class: type[snx.NXobject] | None
+) -> type[snx.NXobject]:
+    if parent_class is not None:
+        return parent_class
+
+    match nx_class:
+        case snx.NXsample:
+            return snx.NXentry
+        case _:
+            # Most components are in the instrument,
+            # callers need to override this for specialized components stored elsewhere.
+            return snx.NXinstrument
 
 
 def _unique_child_group(
@@ -367,6 +469,9 @@ def load_data(
         elif _contains_nx_class(component, snx.NXdata):
             data = _unique_child_group(component, snx.NXdata, None)
             sel = _to_snx_selection(selection, for_events=False)
+        elif _contains_nx_class(component, snx.NXlog):
+            data = _unique_child_group(component, snx.NXlog, "data")
+            sel = _to_snx_selection(selection, for_events=False)
         else:
             raise ValueError(
                 f"NeXus group '{component.name}' contains neither "

{essreduce-25.10.1.dist-info → essreduce-25.10.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: essreduce
-Version: 25.10.1
+Version: 25.10.2
 Summary: Common data reduction tools for the ESS facility
 Author: Scipp contributors
 License-Expression: BSD-3-Clause
@@ -23,7 +23,7 @@ License-File: LICENSE
 Requires-Dist: sciline>=25.05.1
 Requires-Dist: scipp>=25.04.0
 Requires-Dist: scippneutron>=25.02.0
-Requires-Dist: scippnexus>=24.11.0
+Requires-Dist: scippnexus>=25.06.0
 Provides-Extra: test
 Requires-Dist: ipywidgets>=8.1; extra == "test"
 Requires-Dist: numba>=0.59; extra == "test"

{essreduce-25.10.1.dist-info → essreduce-25.10.2.dist-info}/RECORD

@@ -12,8 +12,8 @@ ess/reduce/live/__init__.py,sha256=jPQVhihRVNtEDrE20PoKkclKV2aBF1lS7cCHootgFgI,2
 ess/reduce/live/raw.py,sha256=66qV0G2rP8gK5tXuk-syTlDLE2jT3ehfmSnET7Xzfd0,24392
 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=5N48AMJx1AaFZb6WZPPbVKUlXyFMVVtZrn7Bae57O3A,19842
+ess/reduce/nexus/__init__.py,sha256=8TLqqALxRV5_QdCwLAjq3r6xneq6rzdh2dD7d9AXkYo,1065
+ess/reduce/nexus/_nexus_loader.py,sha256=8jN97CbFaSJ6XZEFzkoeAGyol8WpLTUZsHkUWu8WHsU,23136
 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=DE82JnbgpTlQnt7UN2a2Gur2N9QupV3CDL9j4Iy4lsE,9178
@@ -40,9 +40,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.10.1.dist-info/licenses/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
-essreduce-25.10.1.dist-info/METADATA,sha256=D1WNeIQ0DFiU74eL34et9ndrzzPZODUNqbwcj_D1Yzg,1937
-essreduce-25.10.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-essreduce-25.10.1.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
-essreduce-25.10.1.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
-essreduce-25.10.1.dist-info/RECORD,,
+essreduce-25.10.2.dist-info/licenses/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
+essreduce-25.10.2.dist-info/METADATA,sha256=vCh-Way6GMm-vMBIAIDbApKC17IIgAiWc1KKI43iPj0,1937
+essreduce-25.10.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+essreduce-25.10.2.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
+essreduce-25.10.2.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
+essreduce-25.10.2.dist-info/RECORD,,