Preparation for the new release

.github/copilot-instructions.md

@@ -91,28 +91,37 @@ tox
 ### Docstring Style
 
 - Include docstrings for all public modules, classes, and functions
-- Use **Sphinx/reStructuredText style** docstrings (`:param`, `:type`,
-  `:return`, `:rtype`)
+- Use **NumPy style** docstrings (`Parameters` / `Returns` / `Raises`
+  sections), the style `mkdocstrings` is configured to parse
 - Use clear, concise descriptions
 - Document parameters, return values, and exceptions
 - Example format:
 
   ```python
-  """
-  Brief description of the function.
+  """Brief description of the function.
+
+  Parameters
+  ----------
+  param_name : type
+      Description of the parameter.
 
-  :param param_name: description of parameter
-  :type param_name: type
-  :return: description of return value
-  :rtype: return_type
+  Returns
+  -------
+  type
+      Description of the return value.
   """
   ```
 
 ### Documentation Build
 
-- Documentation is built using Sphinx (version 8.1.3)
-- Source files are in the `docs/` directory
-- Use `myst_parser` (MyST parser) for Markdown support
+- Documentation is built with MkDocs (Material theme), configured in
+  `docs/mkdocs.yml`
+- Source files are Markdown and Jupyter notebooks under `docs/docs/`;
+  every page must be listed in the `nav` section of `docs/mkdocs.yml`
+- API reference pages are one-liners rendered by `mkdocstrings`
+  (`::: easyreflectometry.<module>`)
+- Build locally with `pixi run docs-build` or preview with
+  `pixi run docs-serve`
 - Include code examples in documentation where appropriate
 
 ## Dependencies

.github/workflows/pypi-test.yml

@@ -24,6 +24,8 @@ env:
 jobs:
   # Job 1: Test installation from PyPI on multiple OS
   pypi-package-tests:
+    # Only run the package tests on the master branch
+    if: github.ref == 'refs/heads/master'
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
@@ -45,18 +47,10 @@ jobs:
       - name: Init pixi project
         run: pixi init easyreflectometry
 
-      - name: Set the minimum system requirements
-        working-directory: easyreflectometry
-        run: pixi project system-requirements add macos 14.0
-
       - name: Add Python 3.13 from Conda
         working-directory: easyreflectometry
         run: pixi add "python=3.13"
 
-      - name: Add other Conda dependencies
-        working-directory: easyreflectometry
-        run: pixi add gsl
-
       - name: Add easyreflectometry (with dev dependencies) from PyPI
         working-directory: easyreflectometry
         run: pixi add --pypi "easyreflectometry[dev]"

.github/workflows/python-ci.yml

@@ -13,17 +13,6 @@ name: CI using pip
 on: [push, pull_request]
 
 jobs:
-  Code_Consistency:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
-      - name: Suggestion to fix issues
-        if: ${{ failure() }}
-        run: |
-          echo "::notice::In project root run 'python.exe -m ruff . --fix' and commit changes to fix issues."
-          exit 1
-
   Code_Testing:
     strategy:
       max-parallel: 4

.github/workflows/python-package.yml

@@ -34,7 +34,9 @@ jobs:
       - name: Test with pytest
         run: |
           cd ./dist
-          pytest ../
+          # This workflow only runs on master/pre-release, so include the
+          # `slow` tests that pytest's addopts deselect by default.
+          pytest ../ -m 'slow or not slow'
       - uses: actions/upload-artifact@v4
         with:
           name: EasyReflectometrys - Python ${{ matrix.python-version }}

.github/workflows/test.yml

@@ -54,17 +54,37 @@ jobs:
 
     outputs:
       pytest-marks: ${{ steps.set-mark.outputs.pytest_marks }}
+      unit-task: ${{ steps.set-mark.outputs.unit_task }}
+      integration-task: ${{ steps.set-mark.outputs.integration_task }}
 
     steps:
-      # Determine if integration tests should be run fully or only the fast ones
-      # (to save time on branches other than master and develop)
-      - name: Set mark for integration tests
+      # Tests marked `slow` (real minimizer runs, samplers, long fits) are
+      # deselected by pytest's addopts, so the `*-tests` tasks run the fast
+      # subset and the `*-tests-all` tasks add the slow ones back. Run the
+      # full set where it matters -- pull requests (the release PR included),
+      # master/develop, and manual dispatch -- and the fast subset on ordinary
+      # feature-branch pushes. Integration tests keep their own `fast` gate on
+      # top; the two are mutually exclusive by construction, so only one of
+      # `pytest-marks` / the `-all` task is ever in play.
+      - name: Set marks and task names
         id: set-mark
         run: |
-          if [[ "${{ env.CI_BRANCH }}" == "master" || "${{ env.CI_BRANCH }}" == "develop" ]]; then
+          full_run=false
+          case "${{ github.event_name }}" in
+            pull_request|workflow_dispatch) full_run=true ;;
+          esac
+          case "${{ env.CI_BRANCH }}" in
+            master|develop) full_run=true ;;
+          esac
+
+          if [[ "$full_run" == "true" ]]; then
             echo "pytest_marks=" >> $GITHUB_OUTPUT
+            echo "unit_task=unit-tests-all" >> $GITHUB_OUTPUT
+            echo "integration_task=integration-tests-all" >> $GITHUB_OUTPUT
           else
             echo "pytest_marks=-m fast" >> $GITHUB_OUTPUT
+            echo "unit_task=unit-tests" >> $GITHUB_OUTPUT
+            echo "integration_task=integration-tests" >> $GITHUB_OUTPUT
           fi
 
   # Job 2: Test code
@@ -87,7 +107,7 @@ jobs:
         with:
           environments: ${{ env.PIXI_ENVS }}
 
-      - name: Run unit tests
+      - name: Run unit tests (${{ needs.env-prepare.outputs.unit-task }})
         shell: bash
         run: |
           set -euo pipefail
@@ -99,7 +119,7 @@ jobs:
             env="py-$(echo $py_ver | tr -d .)-env" # Converts 3.XX -> py-3XX-env
 
             echo "Running tests in environment: $env"
-            pixi run --environment $env unit-tests
+            pixi run --environment $env ${{ needs.env-prepare.outputs.unit-task }}
           done
 
       - name: Run functional tests
@@ -117,7 +137,7 @@ jobs:
             pixi run --environment $env functional-tests
           done
 
-      - name: Run integration tests ${{ needs.env-prepare.outputs.pytest-marks }}
+      - name: Run integration tests (${{ needs.env-prepare.outputs.integration-task }})
         shell: bash
         run: |
           set -euo pipefail
@@ -129,7 +149,7 @@ jobs:
             env="py-$(echo $py_ver | tr -d .)-env" # Converts 3.XX -> py-3XX-env
 
             echo "Running tests in environment: $env"
-            pixi run --environment $env integration-tests ${{ needs.env-prepare.outputs.pytest-marks }}
+            pixi run --environment $env ${{ needs.env-prepare.outputs.integration-task }} ${{ needs.env-prepare.outputs.pytest-marks }}
           done
 
       # Delete all local tags when not on a tagged commit to force versioningit
@@ -174,6 +194,8 @@ jobs:
   # Job 3: Test the package
   package-test:
     needs: source-test # depend on previous job
+    # Only run the package tests on the master branch
+    if: github.ref == 'refs/heads/master'
 
     strategy:
       fail-fast: false
@@ -217,9 +239,6 @@ jobs:
             echo "Adding Python $py_ver"
             pixi add "python=$py_ver"
 
-            echo "Setting macOS 14.0 as minimum required"
-            pixi project system-requirements add macos 14.0
-
             echo "Looking for wheel in ../dist/py$py_ver/"
             ls -l "../dist/py$py_ver/"
 
@@ -255,7 +274,8 @@ jobs:
             cd easyreflectometry_py$py_ver
 
             echo "Running tests"
-            pixi run python -m pytest ../tests/unit/ --color=yes -v
+            # This job only runs on master, so always include the `slow` tests.
+            pixi run python -m pytest ../tests/unit/ -m 'slow or not slow' --color=yes -v
 
             echo "Exiting pixi project directory"
             cd ..
@@ -280,7 +300,7 @@ jobs:
             cd ..
           done
 
-      - name: Run integration tests ${{ needs.env-prepare.outputs.pytest-marks }}
+      - name: Run integration tests
         shell: bash
         run: |
           set -euo pipefail
@@ -295,7 +315,7 @@ jobs:
             echo "Running tests"
             # No -n auto: concurrent xdist workers race on arviz's daily-warning
             # stamp file when they import easyreflectometry. See pixi.toml.
-            pixi run python -m pytest ../tests/integration/ --color=yes -v ${{ needs.env-prepare.outputs.pytest-marks }}
+            pixi run python -m pytest ../tests/integration/ -m 'slow or not slow' --color=yes -v
 
             echo "Exiting pixi project directory"
             cd ..

AUTHORS.rst

@@ -8,4 +8,5 @@ Contributors
 * Andrew R. McCluskey <andrew.mccluskey@ess.eu>
 * Andrew Sazonov <andrew.sazonov@ess.eu>
 * Simon Ward <simon.ward@ess.eu>
-* Andreas Pedersen <andreas.pedersen@ess.eu>
+* Andreas Pedersen <andreas.pedersen@ess.eu>
+* Piotr Rozyczko <piotr.rozyczko@ess.eu>