Merge branch 'main' into orso-corrections

Author: jl-wynen

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: ee9a09a
+_commit: 713c40f
 _src_path: gh:scipp/copier_template
 description: Reflectometry data reduction for the European Spallation Source
 max_python: '3.12'

.github/workflows/ci.yml

@@ -27,12 +27,13 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version-file: '.github/workflows/python-version-ci'
-      - run: python -m pip install --upgrade pip
-      - run: python -m pip install -r requirements/ci.txt
-      - run: tox -e static
-      - uses: stefanzweifel/git-auto-commit-action@v5
+      - uses: pre-commit/[email protected]
         with:
-          commit_message: Apply automatic formatting
+          extra_args: --all-files
+      - uses: pre-commit-ci/[email protected]
+        if: always()
+        with:
+          msg: Apply automatic formatting
 
   tests:
     name: Tests

.gitignore

@@ -37,3 +37,4 @@ docs/generated/
 *.raw
 *.cif
 *.rcif
+*.ort

docs/conf.py

@@ -23,6 +23,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
     'sphinx_autodoc_typehints',
     'sphinx_copybutton',
     'sphinx_design',

requirements/base.in

@@ -1,8 +1,5 @@
-# Temporary until questionary (dep of copier) updates
-# See https://github.com/tmbo/questionary/blob/2df265534f3eb77aafcf70902e53e80beb1793e0/pyproject.toml#L36C43-L36C110
-prompt-toolkit==3.0.36
-# Temporary pinned until prompt-tookit conflict is resolved.
-ipython==8.9.0
+# Anything above "--- END OF CUSTOM SECTION ---"
+# will not be touched by ``make_base.py``
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
 dask

requirements/base.txt

@@ -1,4 +1,4 @@
-# SHA1:df5a1bd38eaeab3b3099d7d737171e2192615a39
+# SHA1:697621007a6df52e05884bd9bf630052e4aa6fbe
 #
 # This file is autogenerated by pip-compile-multi
 # To update, run:
@@ -7,8 +7,6 @@
 #
 asttokens==2.4.1
     # via stack-data
-backcall==0.2.0
-    # via ipython
 certifi==2024.2.2
     # via requests
 charset-normalizer==3.3.2
@@ -27,6 +25,8 @@ dask==2024.2.0
     # via -r base.in
 decorator==5.1.1
     # via ipython
+exceptiongroup==1.2.0
+    # via ipython
 executing==2.0.1
     # via stack-data
 fonttools==4.49.0
@@ -45,10 +45,8 @@ importlib-metadata==7.0.1
     # via dask
 ipydatawidgets==4.3.5
     # via pythreejs
-ipython==8.9.0
-    # via
-    #   -r base.in
-    #   ipywidgets
+ipython==8.22.1
+    # via ipywidgets
 ipywidgets==8.1.2
     # via
     #   ipydatawidgets
@@ -88,8 +86,6 @@ partd==1.4.1
     # via dask
 pexpect==4.9.0
     # via ipython
-pickleshare==0.7.5
-    # via ipython
 pillow==10.2.0
     # via matplotlib
 platformdirs==4.2.0
@@ -98,10 +94,8 @@ plopp==24.2.0
     # via -r base.in
 pooch==1.8.1
     # via scippneutron
-prompt-toolkit==3.0.36
-    # via
-    #   -r base.in
-    #   ipython
+prompt-toolkit==3.0.43
+    # via ipython
 ptyprocess==0.7.0
     # via pexpect
 pure-eval==0.2.2

requirements/dev.txt

@@ -95,7 +95,7 @@ python-json-logger==2.0.7
     # via jupyter-events
 pyyaml-include==1.3.2
     # via copier
-questionary==2.0.1
+questionary==1.10.0
     # via copier
 rfc3339-validator==0.1.4
     # via

requirements/make_base.py

@@ -43,7 +43,7 @@ def write_dependencies(dependency_name: str, dependencies: List[str]) -> None:
 with open("../pyproject.toml", "rb") as toml_file:
     pyproject = tomli.load(toml_file)
     dependencies = pyproject["project"].get("dependencies")
-    if not dependencies:
+    if dependencies is None:
         raise RuntimeError("No dependencies found in pyproject.toml")
     dependencies = [dep.strip().strip('"') for dep in dependencies]
 

src/essreflectometry/supermirror/types.py

@@ -2,9 +2,12 @@
 
 import scipp as sc
 
-# TODO What do they mean?
-# Supermirror parameters
+# TODO Better specification of what the supermirror parameters mean
 MValue = NewType('MValue', sc.Variable)
+''':math:`M` value of the supermirror'''
 CriticalEdge = NewType('CriticalEdge', sc.Variable)
+'''Critical edge value of the supermirror'''
 Alpha = NewType('Alpha', sc.Variable)
+''':math:`\\alpha` value of the supermirror'''
 SupermirrorCalibrationFactor = NewType('SupermirrorCalibrationFactor', sc.Variable)
+'''Calibration factor from the supermirror calibration'''