Use normalisation in detector/q space to account for pixel differences

.github/workflows/pr_and_main.yml

@@ -45,7 +45,7 @@ jobs:
           fetch-depth: 0  # history required so cmake can determine version
       - uses: conda-incubator/setup-miniconda@v2
       - run: conda install --channel conda-forge --yes conda-build mamba boa
-      - run: conda mambabuild --channel conda-forge --channel scipp --no-anaconda-upload --override-channels --output-folder conda/package conda
+      - run: conda mambabuild --channel conda-forge --channel scipp --channel mantid --no-anaconda-upload --override-channels --output-folder conda/package conda
 
       - uses: actions/upload-artifact@v2
         with:

.github/workflows/weekly_and_release.yml

@@ -39,7 +39,7 @@ jobs:
           fetch-depth: 0  # history required so cmake can determine version
       - uses: conda-incubator/setup-miniconda@v2
       - run: conda install --channel conda-forge --yes conda-build mamba boa
-      - run: conda mambabuild --channel conda-forge --channel scipp --no-anaconda-upload --override-channels --output-folder conda/package conda
+      - run: conda mambabuild --channel conda-forge --channel scipp --channel mantid --no-anaconda-upload --override-channels --output-folder conda/package conda
 
       - uses: actions/upload-artifact@v2
         with:
@@ -63,7 +63,7 @@ jobs:
       - uses: actions/download-artifact@v2
       - run: anaconda --token ${{ secrets.ANACONDATOKEN }} upload --user scipp --label ${{ env.conda_label }} $(ls conda-package-*/*/*.tar.bz2)
 
-      - uses: JamesIves/github-pages-deploy-action@v4.2.3
+      - uses: JamesIves/github-pages-deploy-action@v4.2.5
         with:
           branch: gh-pages
           folder: DocumentationHTML

README.md

@@ -14,7 +14,7 @@ This supersedes scripts in [ess-legacy](https://github.com/scipp/ess-legacy)
 This is built on and complemented by neutron and technique specific support available in
 [scippneutron](https://github.com/scipp/scippneutron).
 
-Please read the [contribution](contributing.md) guidelines before making additions.
+Please read the [contribution guidelines](https://scipp.github.io/ess/developer/style-guide.html) before making additions.
 
 # Branch organisation
 

conda/meta.yaml

@@ -13,7 +13,7 @@ requirements:
     - ipywidgets
     - matplotlib
     - pooch
-    - scippneutron>=0.4.2
+    - scippneutron>=0.5
     - scipy
     - tifffile
 
@@ -25,7 +25,7 @@ test:
     - ess.reflectometry
   requires:
     - ipympl
-    - mantid-framework
+    - mantid
     - pytest
     - pandoc
     - pythreejs
@@ -34,6 +34,7 @@ test:
     - sphinx-book-theme
     - sphinx-copybutton
     - nbsphinx
+    - pip
   source_files:
     - tests/
     - docs/
@@ -45,6 +46,8 @@ build:
   number: {{ environ.get('GIT_DESCRIBE_NUMBER', 0) }}
   noarch: python
   script:
+    - wget https://files.pythonhosted.org/packages/04/51/4b4a0740fbde50408a2f956cbb190bdc01f1c7a562627e7f102b6a30d9b4/sphinx_autodoc_typehints-1.17.0-py3-none-any.whl
+    - pip install sphinx_autodoc_typehints-1.17.0-py3-none-any.whl
     - pip install .
 
 about:

developer-extra.yml

@@ -0,0 +1,21 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2022 Scipp contributors (https://github.com/scipp)
+
+# This file adds optional dependencies for local development.
+# It should be used in combination with the metatoenv.py script to generate a complete
+# developer environment:
+#
+#   python tools/metatoenv.py --dir=conda --env-file=ess-developer.yml \
+#       --channels=conda-forge,scipp --merge-with=developer-extra.yml
+
+name: developer-extra
+
+channels:
+  - conda-forge
+
+dependencies:
+  - yapf
+  - flake8
+  - pip:
+    - nb-clean
+    - sphinx-autodoc-typehints>=1.17.0

docs/_templates/topbar/launchbuttons.html

@@ -11,6 +11,12 @@
         <a class="dropdown-buttons"
             href="https://scipp.github.io/ess"><button type="button"
                 class="btn btn-secondary topbarbtn">latest</button></a>
+        <a class="dropdown-buttons"
+            href="https://scipp.github.io/ess/release/0.4.0"><button type="button"
+                class="btn btn-secondary topbarbtn">v0.4</button></a>
+        <a class="dropdown-buttons"
+            href="https://scipp.github.io/ess/release/0.3.0"><button type="button"
+                class="btn btn-secondary topbarbtn">v0.3</button></a>
         <a class="dropdown-buttons"
             href="https://scipp.github.io/ess/release/0.2.0"><button type="button"
                 class="btn btn-secondary topbarbtn">v0.2</button></a>

docs/about/release-notes.rst

@@ -3,26 +3,14 @@
 Release Notes
 =============
 
-v0.4.0 (unreleased)
--------------------
-
-Features
-~~~~~~~~
+v0.4.0 (February 2022)
+----------------------
 
 Breaking changes
 ~~~~~~~~~~~~~~~~
 
 * When doing ``import ess``, all the submodules (``amor``, ``reflectometry``, and ``wfm``) are no longer directly available as ``ess.amor``. Instead, we now rely on simply doing ``from ess import amor`` or ``import ess.sans as sans`` `#102 <https://github.com/scipp/ess/pull/102>`_.
 
-Bugfixes
-~~~~~~~~
-
-Deprecations
-~~~~~~~~~~~~
-
-Stability, Maintainability, and Testing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 Contributors
 ~~~~~~~~~~~~
 
@@ -39,18 +27,6 @@ Features
 * Implemented a logging framework for reflectometry and Amor `#93 <https://github.com/scipp/ess/pull/93>`_.
 * Added the ``sans.to_I_of_Q`` workflow to reduce SANS2D data, as well as notebooks that describe the workflow and illustrate its usage `#60 <https://github.com/scipp/ess/pull/60>`_.
 
-Breaking changes
-~~~~~~~~~~~~~~~~
-
-Bugfixes
-~~~~~~~~
-
-Deprecations
-~~~~~~~~~~~~
-
-Stability, Maintainability, and Testing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 Contributors
 ~~~~~~~~~~~~
 
@@ -62,9 +38,6 @@ and Jan-Lukas Wynen :sup:`a`
 v0.2.0 (January 2022)
 ---------------------
 
-Features
-~~~~~~~~
-
 Breaking changes
 ~~~~~~~~~~~~~~~~
 
@@ -75,15 +48,6 @@ Breaking changes
   * The unit conversion (computing wavelength and Q) now use ``transform_coords``.
   * The Amor reduction notebook from ``ess-notebooks`` has been imported into the ``ess`` repository.
 
-Bugfixes
-~~~~~~~~
-
-Deprecations
-~~~~~~~~~~~~
-
-Stability, Maintainability, and Testing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 Contributors
 ~~~~~~~~~~~~
 

docs/conf.py

@@ -38,9 +38,11 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
-    'sphinx.ext.doctest',
+    'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',
     'sphinx_copybutton',
     'IPython.sphinxext.ipython_directive',
     'IPython.sphinxext.ipython_console_highlighting',
@@ -63,6 +65,22 @@
 # For a nice example see how xarray handles its API documentation.
 autosummary_generate = True
 
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_use_param = True
+napoleon_use_rtype = False
+napoleon_preprocess_types = True
+napoleon_type_aliases = {
+    # objects without namespace: scipp
+    "DataArray": "~scipp.DataArray",
+    "Dataset": "~scipp.Dataset",
+    "Variable": "~scipp.Variable",
+    # objects without namespace: numpy
+    "ndarray": "~numpy.ndarray",
+}
+typehints_defaults = 'comma'
+typehints_use_rtype = False
+
 templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
@@ -92,7 +110,7 @@
 #
 html_theme_options = {
     "logo_only": True,
-    "repository_url": "https://github.com/scipp/scipp",
+    "repository_url": "https://github.com/scipp/ess",
     "repository_branch": "main",
     "path_to_docs": "docs",
     "use_repository_button": True,

docs/developer/getting-started.rst

@@ -0,0 +1,61 @@
+Getting Started
+===============
+
+Getting the source code
+~~~~~~~~~~~~~~~~~~~~~~~
+
+To get a copy of the code, you need to clone the git repository (either via SSH or HTTPS)
+from `GitHub <https://github.com/scipp/ess>`_.
+Once you have done this, go inside the top-level folder of the repository.
+
+.. code-block:: bash
+
+  cd ess
+
+Creating a development environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To install all non-optional dependencies for a complete development environment,
+we recommend creating a ``conda`` environment from a generated ``ess-developer.yml``
+file.
+We use the ``tools/metatoenv.py`` script to merge the dependencies in the
+``conda/meta.yaml`` and ``developer-extra.yml`` files into a single
+``ess-developer.yml`` file.
+
+.. code-block:: bash
+
+  python tools/metatoenv.py --dir=conda --env-file=ess-developer.yml \
+    --channels=conda-forge,scipp,mantid --merge-with=developer-extra.yml
+  conda env create -f ess-developer.yml
+  conda activate ess-developer
+
+Once you have activated the environment, you want to ``pip`` install it locally using
+
+.. code-block:: bash
+
+  python -m pip install -e .
+
+
+Running the unit tests
+~~~~~~~~~~~~~~~~~~~~~~
+
+To run the unit tests, simply
+
+.. code-block:: bash
+
+  cd tests/
+  python -m pytest
+
+Building Documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+To build the documentation:
+
+.. code-block:: bash
+
+  cd docs
+  sphinx-build -b html . build
+
+This will build the documentation inside the ``docs/build`` folder.
+If rebuilding the documentation is slow it can be quicker to remove the docs build
+directory and start a fresh build.