essreduce 25.7.1__py3-none-any.whl → 25.9.0__py3-none-any.whl

ess/reduce/data.py

@@ -1,10 +1,29 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright (c) 2024 Scipp contributors (https://github.com/scipp)
-import pooch
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
+"""Data files bundled with ESSreduce."""
+
+from functools import cache
+from pathlib import Path
 
 
 class Registry:
-    def __init__(self, instrument: str, files: dict[str, str], version: str):
+    """A registry for data files.
+
+    Note
+    ----
+    This class requires [Pooch](https://www.fatiando.org/pooch/latest/) which
+    is not a hard dependency of ESSreduce and needs to be installed separately.
+    """
+
+    def __init__(
+        self,
+        instrument: str,
+        files: dict[str, str],
+        version: str,
+        retry_if_failed: int = 3,
+    ) -> None:
+        import pooch
+
         self._registry = pooch.create(
             path=pooch.os_cache(f'ess/{instrument}'),
             env=f'ESS_{instrument.upper()}_DATA_DIR',
@@ -12,14 +31,27 @@ class Registry:
             + '{version}/',
             version=version,
             registry=files,
+            retry_if_failed=retry_if_failed,
         )
+        self._unzip_processor = pooch.Unzip()
 
-    def __contains__(self, key):
+    def __contains__(self, key: str) -> bool:
+        """Return True if the key is in the registry."""
         return key in self._registry.registry
 
-    def get_path(self, name: str, unzip: bool = False) -> str:
-        """
-        Get the path to a file in the registry.
+    @cache  # noqa: B019
+    def get_path(self, name: str, unzip: bool = False) -> Path:
+        """Get the path to a file in the registry.
+
+        Downloads the file if necessary.
+
+        Note that return values of this method are cached to avoid recomputing
+        potentially expensive checksums.
+        This usually means that the ``Registry`` object itself gets stored until the
+        Python interpreter shuts down.
+        However, registries are small and do not own resources.
+        It is anyway expected that the registry objects are stored at
+        module scope and live until program exit.
 
         Parameters
         ----------
@@ -27,8 +59,17 @@ class Registry:
             Name of the file to get the path for.
         unzip:
             If `True`, unzip the file before returning the path.
+
+        Returns
+        -------
+        :
+            The Path to the file.
         """
-        return self._registry.fetch(name, processor=pooch.Unzip() if unzip else None)
+        return Path(
+            self._registry.fetch(
+                name, processor=self._unzip_processor if unzip else None
+            )
+        )
 
 
 _bifrost_registry = Registry(
@@ -75,37 +116,37 @@ _loki_registry = Registry(
 )
 
 
-def bifrost_simulated_elastic() -> str:
+def bifrost_simulated_elastic() -> Path:
     """McStas simulation with elastic incoherent scattering + phonon."""
     return _bifrost_registry.get_path('BIFROST_20240914T053723.h5')
 
 
-def loki_tutorial_sample_run_60250() -> str:
+def loki_tutorial_sample_run_60250() -> Path:
     """Sample run with sample and sample holder/can, no transmission monitor in beam."""
     return _loki_registry.get_path('60250-2022-02-28_2215.nxs')
 
 
-def loki_tutorial_sample_run_60339() -> str:
+def loki_tutorial_sample_run_60339() -> Path:
     """Sample run with sample and sample holder/can, no transmission monitor in beam."""
     return _loki_registry.get_path('60339-2022-02-28_2215.nxs')
 
 
-def loki_tutorial_background_run_60248() -> str:
+def loki_tutorial_background_run_60248() -> Path:
     """Background run with sample holder/can only, no transmission monitor."""
     return _loki_registry.get_path('60248-2022-02-28_2215.nxs')
 
 
-def loki_tutorial_background_run_60393() -> str:
+def loki_tutorial_background_run_60393() -> Path:
     """Background run with sample holder/can only, no transmission monitor."""
     return _loki_registry.get_path('60393-2022-02-28_2215.nxs')
 
 
-def loki_tutorial_sample_transmission_run() -> str:
+def loki_tutorial_sample_transmission_run() -> Path:
     """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:
+def dream_coda_test_file() -> Path:
     """CODA file for DREAM where most pulses have been removed.
 
     See ``tools/shrink_nexus.py``.

essreduce-25.9.0.dist-info/METADATA

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: essreduce
+Version: 25.9.0
+Summary: Common data reduction tools for the ESS facility
+Author: Scipp contributors
+License-Expression: BSD-3-Clause
+Project-URL: Bug Tracker, https://github.com/scipp/essreduce/issues
+Project-URL: Documentation, https://scipp.github.io/essreduce
+Project-URL: Source, https://github.com/scipp/essreduce
+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: sciline>=25.05.1
+Requires-Dist: scipp>=25.04.0
+Requires-Dist: scippneutron>=25.02.0
+Requires-Dist: scippnexus>=24.11.0
+Provides-Extra: test
+Requires-Dist: ipywidgets>=8.1; extra == "test"
+Requires-Dist: numba>=0.59; extra == "test"
+Requires-Dist: pooch>=1.5; extra == "test"
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: scipy>=1.14; extra == "test"
+Requires-Dist: tof>=25.05.0; extra == "test"
+Dynamic: license-file
+
+[![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/essreduce.svg)](https://pypi.python.org/pypi/essreduce)
+[![Anaconda-Server Badge](https://anaconda.org/conda-forge/essreduce/badges/version.svg)](https://anaconda.org/conda-forge/essreduce)
+[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
+
+# ESSreduce
+
+## About
+
+Common data reduction tools for the ESS facility
+
+## Installation
+
+```sh
+python -m pip install essreduce
+```

{essreduce-25.7.1.dist-info → essreduce-25.9.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ess/reduce/__init__.py,sha256=o1pWRP9YGwTukM_k-qlG6KcoXOpMb0PDVH59vod12lw,419
-ess/reduce/data.py,sha256=0N7iq1363tO16ntMztTNjxkQDFst-Gnp9awpgUOBVdY,4133
+ess/reduce/data.py,sha256=66FYykg1do4xc_oEEeCu3pyAsyFwniUqEE3ofQIVvwI,5337
 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
@@ -39,9 +39,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.7.1.dist-info/licenses/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
-essreduce-25.7.1.dist-info/METADATA,sha256=wJNhY-mZpbNQwbSdKA1Ju0gTYSAU62tivdyuBmgG5Pc,3768
-essreduce-25.7.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-essreduce-25.7.1.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
-essreduce-25.7.1.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
-essreduce-25.7.1.dist-info/RECORD,,
+essreduce-25.9.0.dist-info/licenses/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
+essreduce-25.9.0.dist-info/METADATA,sha256=T-UsR4D9r5xXxCRWnc_LFgI9ogEWKK2GBkfn5MD4cP8,1936
+essreduce-25.9.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+essreduce-25.9.0.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
+essreduce-25.9.0.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
+essreduce-25.9.0.dist-info/RECORD,,

essreduce-25.7.1.dist-info/METADATA

@@ -1,82 +0,0 @@
-Metadata-Version: 2.4
-Name: essreduce
-Version: 25.7.1
-Summary: Common data reduction tools for the ESS facility
-Author: Scipp contributors
-License: BSD 3-Clause License
-        
-        Copyright (c) 2024, Scipp contributors (https://github.com/scipp)
-        All rights reserved.
-        
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are met:
-        
-        1. Redistributions of source code must retain the above copyright notice, this
-           list of conditions and the following disclaimer.
-        
-        2. Redistributions in binary form must reproduce the above copyright notice,
-           this list of conditions and the following disclaimer in the documentation
-           and/or other materials provided with the distribution.
-        
-        3. Neither the name of the copyright holder nor the names of its
-           contributors may be used to endorse or promote products derived from
-           this software without specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
-Project-URL: Bug Tracker, https://github.com/scipp/essreduce/issues
-Project-URL: Documentation, https://scipp.github.io/essreduce
-Project-URL: Source, https://github.com/scipp/essreduce
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
-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.10
-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.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: sciline>=25.05.1
-Requires-Dist: scipp>=25.01.0
-Requires-Dist: scippneutron>=25.02.0
-Requires-Dist: scippnexus>=24.11.0
-Provides-Extra: test
-Requires-Dist: ipywidgets; extra == "test"
-Requires-Dist: numba; extra == "test"
-Requires-Dist: pooch; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: scipy>=1.7.0; extra == "test"
-Requires-Dist: tof>=25.05.0; extra == "test"
-Dynamic: license-file
-
-[![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/essreduce.svg)](https://pypi.python.org/pypi/essreduce)
-[![Anaconda-Server Badge](https://anaconda.org/scipp/essreduce/badges/version.svg)](https://anaconda.org/scipp/essreduce)
-[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
-
-# ESSreduce
-
-## About
-
-Common data reduction tools for the ESS facility
-
-## Installation
-
-```sh
-python -m pip install essreduce
-```