Frame unwrapping and WFM

.buildconfig/ci-linux.yml

@@ -39,3 +39,6 @@ dependencies:
   - sphinx-copybutton==0.5.2
   - sphinx-design==0.5.0
   - sphinxcontrib-bibtex==2.6.1
+
+  # docs and tests
+  - sciline==24.01.1

.buildconfig/ci-macos.yml

@@ -19,3 +19,6 @@ dependencies:
   - scipp==23.07.0
   - scippnexus==23.12.1
   - scipy==1.12.0
+
+  # docs and tests
+  - sciline==24.01.1

.buildconfig/ci-windows.yml

@@ -19,3 +19,6 @@ dependencies:
   - scipp==23.07.0
   - scippnexus==23.12.1
   - scipy==1.12.0
+
+  # docs and tests
+  - sciline==24.01.1

docs/api-reference/chopper-cascade.ipynb

@@ -21,7 +21,8 @@
    "source": [
     "## Example: WFM chopper cascade\n",
     "\n",
-    "As an example, consider the WFM chopper cascade from [the tof package documentation](https://tof.readthedocs.io/en/stable/short-example.html):"
+    "As an example, consider the WFM chopper cascade from [the tof package documentation](https://tof.readthedocs.io/en/stable/short-example.html).\n",
+    "The choppers are defined in the `fakes` module of the `tof` package:"
    ]
   },
   {
@@ -30,148 +31,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from scippneutron.tof import chopper_cascade\n",
+    "from scippneutron.tof import chopper_cascade, fakes\n",
     "import scipp as sc\n",
     "import matplotlib as mpl\n",
     "\n",
-    "mpl.rcParams['figure.dpi'] = 300"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "wfm1 = chopper_cascade.Chopper(\n",
-    "    distance=sc.scalar(6.6, unit='m'),\n",
-    "    time_open=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            -0.000396,\n",
-    "            0.001286,\n",
-    "            0.005786,\n",
-    "            0.008039,\n",
-    "            0.010133,\n",
-    "            0.012080,\n",
-    "            0.013889,\n",
-    "            0.015571,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    "    time_close=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            0.000654,\n",
-    "            0.002464,\n",
-    "            0.006222,\n",
-    "            0.008646,\n",
-    "            0.010899,\n",
-    "            0.012993,\n",
-    "            0.014939,\n",
-    "            0.016750,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    ")\n",
-    "wfm2 = chopper_cascade.Chopper(\n",
-    "    distance=sc.scalar(7.1, unit='m'),\n",
-    "    time_open=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            0.000654,\n",
-    "            0.002451,\n",
-    "            0.006222,\n",
-    "            0.008645,\n",
-    "            0.010898,\n",
-    "            0.012993,\n",
-    "            0.014940,\n",
-    "            0.016737,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    "    time_close=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            0.001567,\n",
-    "            0.003641,\n",
-    "            0.006658,\n",
-    "            0.009252,\n",
-    "            0.011664,\n",
-    "            0.013759,\n",
-    "            0.015853,\n",
-    "            0.017927,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    ")\n",
-    "frame_overlap_1 = chopper_cascade.Chopper(\n",
-    "    distance=sc.scalar(8.8, unit='m'),\n",
-    "    time_open=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            -0.000139,\n",
-    "            0.002460,\n",
-    "            0.006796,\n",
-    "            0.010020,\n",
-    "            0.012733,\n",
-    "            0.015263,\n",
-    "            0.017718,\n",
-    "            0.020317,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    "    time_close=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            0.000640,\n",
-    "            0.003671,\n",
-    "            0.007817,\n",
-    "            0.011171,\n",
-    "            0.013814,\n",
-    "            0.016146,\n",
-    "            0.018497,\n",
-    "            0.021528,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    ")\n",
-    "frame_overlap_2 = chopper_cascade.Chopper(\n",
-    "    distance=sc.scalar(15.9, unit='m'),\n",
-    "    time_open=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            -0.000306,\n",
-    "            0.010939,\n",
-    "            0.016495,\n",
-    "            0.021733,\n",
-    "            0.026416,\n",
-    "            0.030880,\n",
-    "            0.035409,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    "    time_close=sc.array(\n",
-    "        dims=('cutout',),\n",
-    "        values=[\n",
-    "            0.002582,\n",
-    "            0.014570,\n",
-    "            0.020072,\n",
-    "            0.024730,\n",
-    "            0.029082,\n",
-    "            0.033316,\n",
-    "            0.038297,\n",
-    "        ],\n",
-    "        unit='s',\n",
-    "    ),\n",
-    ")\n",
-    "pulse_overlap = chopper_cascade.Chopper(\n",
-    "    distance=sc.scalar(22.0, unit='m'),\n",
-    "    time_open=sc.array(dims=('cutout',), values=[-0.130952, 0.011905], unit='s'),\n",
-    "    time_close=sc.array(dims=('cutout',), values=[-0.087302, 0.055556], unit='s'),\n",
-    ")\n",
-    "\n",
-    "choppers = [wfm1, wfm2, frame_overlap_1, frame_overlap_2, pulse_overlap]"
+    "mpl.rcParams['figure.dpi'] = 300\n",
+    "choppers = fakes.wfm_choppers"
    ]
   },
   {
@@ -193,7 +58,7 @@
     "    wavelength_min=sc.scalar(0.0, unit='angstrom'),\n",
     "    wavelength_max=sc.scalar(10.0, unit='angstrom'),\n",
     ")\n",
-    "frames = frames.chop(choppers)\n",
+    "frames = frames.chop(choppers.values())\n",
     "at_sample = frames.propagate_to(sc.scalar(26.0, unit='m'))\n",
     "\n",
     "at_sample.draw()"
@@ -296,7 +161,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.16"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,