Reflectometry rewrite

conda/meta.yaml

@@ -11,7 +11,7 @@ requirements:
     - sphinx_rtd_theme
     - gitpython
   run:
-    - scippneutron=0.4.*
+    - scippneutron>=0.4.1
     - tifffile
     - astropy
     - matplotlib

docs/_templates/ess-class-template.rst

@@ -0,0 +1,30 @@
+{{ fullname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/_templates/ess-module-template.rst

@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Module Attributes') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: ess-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: ess-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/about/release-notes.rst

@@ -3,6 +3,40 @@
 Release Notes
 =============
 
+v0.2.0 (unreleased)
+-------------------
+
+Features
+~~~~~~~~
+
+Breaking changes
+~~~~~~~~~~~~~~~~
+
+* A major rewrite of the reflectometry code was undertaken `#61 <https://github.com/scipp/ess/pull/61>`_:
+
+  * The reflectometry and Amor Data classes were removed in favour of a formalism consisting of free-functions that accept Scipp DataArrays and Datasets.
+  * Moved the chopper class from the `wfm` submodule to free functions in its own ``choppers`` module.
+  * 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
+~~~~~~~~~~~~
+
+Owen Arnold :sup:`b, c`\ ,
+Simon Heybrock :sup:`a`\ ,
+Andrew McCluskey :sup:`a`\ ,
+Samuel Jones :sup:`b`\ ,
+and Neil Vaytet :sup:`a`\
+
 v0.1.0 (September 2021)
 -----------------------
 

docs/conf.py

@@ -28,8 +28,8 @@
 # -- Project information -----------------------------------------------------
 
 project = u'ess'
-copyright = u'2020 scipp ess contributors'
-copyright = u'scipp ess contributors'
+copyright = u'2021 Scipp contributors'
+copyright = u'scipp contributors'
 
 # The full version, including alpha/beta/rc tags
 version = u''
@@ -51,6 +51,8 @@
     'nbsphinx',
 ]
 
+autodoc_typehints = 'description'
+
 # autodocs includes everything, even irrelevant API internals. autosummary
 # looks more suitable in the long run when the API grows.
 # For a nice example see how xarray handles its API documentation.

docs/index.rst

@@ -34,14 +34,14 @@ Documentation
    :maxdepth: 3
    :caption: Instruments
 
-   instruments/amor
+   instruments/amor/amor
 
 .. toctree::
    :maxdepth: 3
    :caption: Techniques
 
-   techniques/reflectometry
-   techniques/wfm
+   techniques/reflectometry/reflectometry
+   techniques/wfm/wfm
 
 .. toctree::
    :caption: About

docs/instruments/amor.rst → docs/instruments/amor/amor.rst

@@ -4,5 +4,5 @@ Amor
 .. toctree::
    :maxdepth: 4
 
-   amor/amor_data
-   amor/tools
+   amor_reduction
+   reference