Merge pull request #190 from scipp/new-tof-lut-workflow

Update to use the new tof lookup table workflow

Author: nvaytet

tools/dream-make-tof-lookup-table.ipynb renamed to docs/user-guide/dream/dream-make-tof-lookup-table.ipynb

@@ -5,7 +5,9 @@
    "id": "0",
    "metadata": {},
    "source": [
-    "# Create a time-of-flight lookup table for DREAM"
+    "# Create a time-of-flight lookup table for DREAM\n",
+    "\n",
+    "This notebook shows how to create a time-of-flight lookup table for the DREAM instrument."
    ]
   },
   {
@@ -16,7 +18,6 @@
    "outputs": [],
    "source": [
     "import scipp as sc\n",
-    "import sciline as sl\n",
     "from ess.reduce import time_of_flight\n",
     "from ess.dream.beamline import InstrumentConfiguration, choppers"
    ]
@@ -26,7 +27,9 @@
    "id": "2",
    "metadata": {},
    "source": [
-    "## Select the choppers"
+    "## Select the choppers\n",
+    "\n",
+    "We select the choppers for the 'high-flux' configuration."
    ]
   },
   {
@@ -54,15 +57,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "wf = sl.Pipeline(\n",
-    "    time_of_flight.providers(), params=time_of_flight.default_parameters()\n",
-    ")\n",
+    "wf = time_of_flight.TofLookupTableWorkflow()\n",
     "\n",
     "wf[time_of_flight.LtotalRange] = sc.scalar(60.0, unit=\"m\"), sc.scalar(80.0, unit=\"m\")\n",
-    "wf[time_of_flight.SimulationResults] = time_of_flight.simulate_beamline(\n",
-    "    choppers=disk_choppers, neutrons=5_000_000, source_position=sc.vector([0, 0, 0], unit='m'),\n",
-    ")\n",
-    "\n",
+    "wf[time_of_flight.NumberOfSimulatedNeutrons] = 200_000  # Increase this number for more reliable results\n",
+    "wf[time_of_flight.SourcePosition] = sc.vector([0, 0, 0], unit='m')\n",
+    "wf[time_of_flight.DiskChoppers] = disk_choppers\n",
     "wf[time_of_flight.DistanceResolution] = sc.scalar(0.1, unit=\"m\")\n",
     "wf[time_of_flight.TimeResolution] = sc.scalar(250.0, unit='us')\n",
     "wf[time_of_flight.LookupTableRelativeErrorThreshold] = 0.02\n",

docs/user-guide/dream/index.md

@@ -54,4 +54,5 @@ dream-instrument-view
 workflow-widget-dream
 dream-detector-diagnostics
 dream-visualize-absorption
+dream-make-tof-lookup-table
 ```

pyproject.toml

@@ -32,7 +32,7 @@ requires-python = ">=3.10"
 # Make sure to list one dependency per line.
 dependencies = [
   "dask",
-  "essreduce>=25.05.3",
+  "essreduce>=25.07.0",
   "graphviz",
   "numpy",
   "plopp>=25.03.0",

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.3
+essreduce>=25.07.0
 graphviz
 numpy
 plopp>=25.03.0

requirements/base.txt

@@ -1,9 +1,9 @@
-# SHA1:81114073dd5e4b765405b54b3976f92d6a96439b
+# SHA1:8f044677d4db96fd48743befd036bb0b7410e72f
 #
-# This file was generated by pip-compile-multi.
+# This file is autogenerated by pip-compile-multi
 # To update, run:
 #
-#    requirements upgrade
+#    pip-compile-multi
 #
 annotated-types==0.7.0
     # via pydantic
@@ -21,21 +21,21 @@ cyclebane==24.10.0
     # via sciline
 cycler==0.12.1
     # via matplotlib
-dask==2025.5.1
+dask==2025.7.0
     # 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.3
+essreduce==25.7.0
     # via -r base.in
 exceptiongroup==1.3.0
     # via ipython
 executing==2.2.0
     # via stack-data
-fonttools==4.58.4
+fonttools==4.58.5
     # via matplotlib
 fsspec==2025.5.1
     # via dask
@@ -143,7 +143,7 @@ scipp==25.5.1
     #   scippneutron
     #   scippnexus
     #   tof
-scippneutron==25.6.0
+scippneutron==25.7.0
     # via
     #   -r base.in
     #   essreduce
@@ -177,7 +177,7 @@ traitlets==5.14.3
     #   traittypes
 traittypes==0.2.1
     # via ipydatawidgets
-typing-extensions==4.14.0
+typing-extensions==4.14.1
     # via
     #   exceptiongroup
     #   ipython

requirements/basetest.txt

@@ -1,11 +1,11 @@
 # SHA1:c4f3e9aaa3abd10fcdf497bea14415857f62cc89
 #
-# This file was generated by pip-compile-multi.
+# This file is autogenerated by pip-compile-multi
 # To update, run:
 #
-#    requirements upgrade
+#    pip-compile-multi
 #
-certifi==2025.6.15
+certifi==2025.7.14
     # via requests
 charset-normalizer==3.4.2
     # via requests
@@ -21,7 +21,7 @@ packaging==25.0
     # via
     #   pooch
     #   pytest
-pandas==2.3.0
+pandas==2.3.1
     # via -r basetest.in
 platformdirs==4.3.8
     # via pooch
@@ -43,7 +43,7 @@ six==1.17.0
     # via python-dateutil
 tomli==2.2.1
     # via pytest
-typing-extensions==4.14.0
+typing-extensions==4.14.1
     # via exceptiongroup
 tzdata==2025.2
     # via pandas

requirements/ci.txt

@@ -1,13 +1,13 @@
 # SHA1:6344d52635ea11dca331a3bc6eb1833c4c64d585
 #
-# This file was generated by pip-compile-multi.
+# This file is autogenerated by pip-compile-multi
 # To update, run:
 #
-#    requirements upgrade
+#    pip-compile-multi
 #
 cachetools==6.1.0
     # via tox
-certifi==2025.6.15
+certifi==2025.7.14
     # via requests
 chardet==5.2.0
     # via tox
@@ -50,7 +50,7 @@ tomli==2.2.1
     #   tox
 tox==4.27.0
     # via -r ci.in
-typing-extensions==4.14.0
+typing-extensions==4.14.1
     # via tox
 urllib3==2.5.0
     # via requests

requirements/dev.txt

@@ -1,9 +1,9 @@
 # SHA1:efd19a3a98c69fc3d6d6233ed855de7e4a208f74
 #
-# This file was generated by pip-compile-multi.
+# This file is autogenerated by pip-compile-multi
 # To update, run:
 #
-#    requirements upgrade
+#    pip-compile-multi
 #
 -r base.txt
 -r ci.txt
@@ -26,9 +26,9 @@ async-lru==2.0.5
     # via jupyterlab
 cffi==1.17.1
     # via argon2-cffi-bindings
-copier==9.7.1
+copier==9.8.0
     # via -r dev.in
-dunamai==1.24.1
+dunamai==1.25.0
     # via copier
 fqdn==1.5.1
     # via jsonschema
@@ -105,7 +105,7 @@ terminado==0.18.1
     #   jupyter-server-terminals
 toposort==1.10
     # via pip-compile-multi
-types-python-dateutil==2.9.0.20250516
+types-python-dateutil==2.9.0.20250708
     # via arrow
 uri-template==1.3.0
     # via jsonschema

requirements/docs.txt

@@ -1,9 +1,9 @@
 # SHA1:f584be06df2929a863ef5490377cbfe43c8e99a0
 #
-# This file was generated by pip-compile-multi.
+# This file is autogenerated by pip-compile-multi
 # To update, run:
 #
-#    requirements upgrade
+#    pip-compile-multi
 #
 -r base.txt
 accessible-pygments==0.0.5
@@ -26,7 +26,7 @@ beautifulsoup4==4.13.4
     #   pydata-sphinx-theme
 bleach[css]==6.2.0
     # via nbconvert
-certifi==2025.6.15
+certifi==2025.7.14
     # via requests
 charset-normalizer==3.4.2
     # via requests
@@ -104,7 +104,7 @@ nbsphinx==0.9.7
     # via -r docs.in
 nest-asyncio==1.6.0
     # via ipykernel
-pandas==2.3.0
+pandas==2.3.1
     # via -r docs.in
 pandocfilters==1.5.1
     # via nbconvert

requirements/mypy.txt

@@ -1,12 +1,12 @@
 # SHA1:859ef9c15e5e57c6c91510133c01f5751feee941
 #
-# This file was generated by pip-compile-multi.
+# This file is autogenerated by pip-compile-multi
 # To update, run:
 #
-#    requirements upgrade
+#    pip-compile-multi
 #
 -r test.txt
-mypy==1.16.1
+mypy==1.17.0
     # via -r mypy.in
 mypy-extensions==1.1.0
     # via mypy