Merge pull request #574 from scipp/avoid-tof-clash

Add missing tof dependency, avoid tof clash and fix failing test in conda build

Author: nvaytet

conda/meta.yaml

@@ -34,6 +34,9 @@ test:
   {% for package in test_dependencies %}
     - {% if package == "graphviz" %}python-graphviz{% else %}{{ package|replace(" ", "") }}{% endif %}
   {% endfor %}
+    # Note that we add tof here because it depends on plopp, and plopp should not be in
+    # basetest.in because of the nightly dependencies
+    - tof
 
   source_files:
     - pyproject.toml

src/scippneutron/tof/chopper_cascade.py

@@ -146,6 +146,20 @@ class Frame:
     distance: sc.Variable
     subframes: list[Subframe]
 
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, Frame):
+            return NotImplemented
+        # Note: we don't use sc.identical here because it can fail on the dtype even
+        # if the values are equal.
+        same_distance = (
+            np.array_equal(self.distance.values, other.distance.values)
+            and self.distance.unit == other.distance.unit
+        )
+        return same_distance and all(
+            self_sub == other_sub
+            for self_sub, other_sub in zip(self.subframes, other.subframes, strict=True)
+        )
+
     def propagate_to(self, distance: sc.Variable) -> Frame:
         """
         Compute new frame by propagating to a distance.

src/scippneutron/tof/fakes.py

@@ -241,7 +241,7 @@ def __init__(
     ):
         import math
 
-        import tof
+        import tof as tof_pkg
         from tof.facilities.ess_pulse import pulse
 
         self.frequency = pulse.frequency
@@ -250,7 +250,7 @@ def __init__(
 
         # Create a source
         if source is None:
-            self.source = tof.Source(
+            self.source = tof_pkg.Source(
                 facility='ess', neutrons=self.events_per_pulse, pulses=self.npulses
             )
         else:
@@ -260,7 +260,7 @@ def __init__(
         angular_speed = sc.constants.pi * (2.0 * sc.units.rad) * self.frequency
 
         self.choppers = [
-            tof.Chopper(
+            tof_pkg.Chopper(
                 frequency=pulse.frequency,
                 open=ch.time_open * angular_speed,
                 close=ch.time_close * angular_speed,
@@ -273,12 +273,12 @@ def __init__(
 
         # Add detectors
         self.monitors = [
-            tof.Detector(distance=distance, name=key)
+            tof_pkg.Detector(distance=distance, name=key)
             for key, distance in monitors.items()
         ]
 
         #  Propagate the neutrons
-        self.model = tof.Model(
+        self.model = tof_pkg.Model(
             source=self.source, choppers=self.choppers, detectors=self.monitors
         )
         self.model_result = self.model.run()

tests/tof/wfm_dream_test.py

@@ -5,7 +5,7 @@
 
 import pytest
 import scipp as sc
-import tof
+import tof as tof_pkg
 
 from scippneutron.chopper import DiskChopper
 from scippneutron.conversion.graph.beamline import beamline
@@ -143,7 +143,7 @@ def test_dream_wfm(disk_choppers, npulses, ltotal):
         run_length=sc.scalar(1 / 14, unit="s") * npulses,
         events_per_pulse=len(wavelengths),
         source=partial(
-            tof.Source.from_neutrons,
+            tof_pkg.Source.from_neutrons,
             birth_times=birth_times,
             wavelengths=wavelengths,
             frequency=sc.scalar(14.0, unit="Hz"),
@@ -256,7 +256,7 @@ def test_dream_wfm_with_subframe_time_overlap(overlap_choppers, npulses, ltotal)
         run_length=sc.scalar(1 / 14, unit="s") * npulses,
         events_per_pulse=len(wavelengths),
         source=partial(
-            tof.Source.from_neutrons,
+            tof_pkg.Source.from_neutrons,
             birth_times=birth_times,
             wavelengths=wavelengths,
             frequency=sc.scalar(14.0, unit="Hz"),

tests/tof/wfm_v20_test.py

@@ -6,7 +6,7 @@
 import numpy as np
 import pytest
 import scipp as sc
-import tof
+import tof as tof_pkg
 
 from scippneutron.chopper import DiskChopper
 from scippneutron.conversion.graph.beamline import beamline
@@ -131,7 +131,7 @@ def test_v20_compute_wavelengths_from_wfm(disk_choppers, npulses, ltotal):
         run_length=sc.scalar(1 / 14, unit="s") * npulses,
         events_per_pulse=len(wavelengths),
         source=partial(
-            tof.Source.from_neutrons,
+            tof_pkg.Source.from_neutrons,
             birth_times=birth_times,
             wavelengths=wavelengths,
             frequency=sc.scalar(14.0, unit="Hz"),