Merge remote-tracking branch 'origin/release-v3.11'

Framework/Kernel/src/MantidVersion.cpp.in

@@ -39,13 +39,13 @@ std::string MantidVersion::releaseNotes()
   // for now the code assumes that the next main release version number will be one minor version higher
 
   std::stringstream versionLabel;
-  
-  if(( patchVersion < 100 ) && ( patchVersion != 0 )) {
+
+  if ( patchVersion < 100 ) {
     versionLabel << versionShort();
     versionLabel << "." << patchVersion;
   }
   else {
-  	const unsigned int minorVersion = static_cast<unsigned int>(@VERSION_MINOR@);
+    const unsigned int minorVersion = static_cast<unsigned int>(@VERSION_MINOR@);
     versionLabel << "@VERSION_MAJOR@." << minorVersion + 1  << "." << "0";
   }
 

buildconfig/CMake/VersionNumber.cmake

@@ -6,4 +6,4 @@ set ( VERSION_MINOR 11 )
 # UNCOMMENT the next 'set' line to 'force' the patch version number to
 # a value (instead of using the count coming out of 'git describe')
 # DO NOT COMMIT THIS TO MASTER UNCOMMENTED, ONLY TO A RELEASE BRANCH
-#set ( VERSION_PATCH 0 )
+set ( VERSION_PATCH 0 )

docs/source/algorithms/FindSXPeaks-v1.rst

@@ -28,8 +28,8 @@ Strongest peak mode:
   :math:`\phi`, :math:`2\theta`, and :math:`t` of two found peaks.  If the
   absolute difference between any of the parameters for two peaks is greater
   than the product of the tolerance value and the parameter value then the two
-  peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| >
-  tolerance * \phi_1` then peaks 1 & 2 are not the same (as well as similar
+  peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| > tolerance * \phi_1` 
+  then peaks 1 & 2 are not the same (as well as similar
   definitions for :math:`2\theta` and :math:`t`).
 
 
@@ -51,8 +51,8 @@ All peaks mode:
   difference between the parameters :math:`\phi`, :math:`2\theta`, and
   :math:`t` of two found peaks.  If the absolute difference between any of the
   parameters for two peaks is greater than the absolute tolerance then the two
-  peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| >
-  PhiTolerance then peaks 1 & 2 are not the same (as well as similar
+  peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| >  PhiTolerance` 
+  then peaks 1 & 2 are not the same (as well as similar
   definitions for :math:`2\theta` and :math:`t`).
 
 

docs/source/fitfunctions/MsdGauss.rst

@@ -11,11 +11,13 @@ Description
 
 The Gaussian model for Mean-squared displacement fitting is defined as:
 
-.. math:: \mbox{Height}e^{-MSD x^2}
+.. math:: 
+
+    \mbox{Height}\cdot e^{-MSD\cdot x^2}
 
 where:
--   .. math:: `MSD` is the mean squared displacement
--   .. math:: `Height` is the intensity scaling
+  - :math:`MSD`  is the mean squared displacement
+  - :math:`Height` is the intensity scaling
 
 .. attributes::
 

docs/source/fitfunctions/MsdPeters.rst

@@ -13,12 +13,12 @@ The Peters model for Mean-squared displacement fitting is defined as:
 
 .. math::
 
-    \frac{Height}{\power{1 + \frac{MSD x^2}{6 \beta}}{\beta}}
+    \frac{Height}{\left(1 + \frac{MSD\cdot x^2}{6 \beta}\right)^\beta}
 
 where:
--   .. math::`MSD` is the mean-squared displacement
--   .. math::`\beta` is the inverse scale/rate parameter
--   .. math::`Height` is the intensity scaling
+  - :math:`MSD` is the mean-squared displacement
+  - :math:`\beta` is the inverse scale/rate parameter
+  - :math:`Height` is the intensity scaling
 
 .. attributes::
 

docs/source/fitfunctions/MsdYi.rst

@@ -13,12 +13,12 @@ The Yi model for Mean-squared displacement fitting is defined as:
 
 .. math::
 
-    Height \exp(\frac{-1}{6 x^2 MSD}) (1 + \frac{x^4 * \sigma}{72})
+    Height \exp\left(\frac{-1}{6 x^2 MSD}\right) \left(1 + \frac{x^4 * \sigma}{72}\right)
 
 where:
--   .. math::`MSD` is the mean squared displacement
--   .. math::`Sigma` is the standard deviation
--   .. math::`Height` is the intensity scaling
+  - :math:`MSD` is the mean squared displacement
+  - :math:`Sigma` is the standard deviation
+  - :math:`Height` is the intensity scaling
 
 .. attributes::
 

docs/source/release/v3.11.0/diffraction.rst

@@ -21,6 +21,13 @@ Powder Diffraction
 Single Crystal Diffraction
 --------------------------
 
+.. figure:: ../../images/SingleCrystalDiffuseReduction_corelli_multiple_sym_bkg.png
+   :class: screenshot
+   :width: 385px
+   :align: center
+
+   SingleCrystalDiffuseReduction output from CORELLI data.
+
 - New algorithm :ref:`SingleCrystalDiffuseReduction <algm-SingleCrystalDiffuseReduction>` which performs the most common reductions done on Corelli (and elsewhere) for single crystal diffuse scattering.
 - New algorithm :ref:`ConvertMultipleRunsToSingleCrystalMD <algm-ConvertMultipleRunsToSingleCrystalMD>` which loads, converts to single crystal MDWorkspace and combines a series of runs.
 - :ref:`FindPeaksMD <algm-FindPeaksMD>` has been modified to only add peaks to runs that contributed to that peak. This is a lot faster when multiple runs are in the same MDworkspace.

docs/source/release/v3.11.0/indirect_inelastic.rst

@@ -16,7 +16,7 @@ New
 Improved
 ########
 - The following changes were made to the :ref:`algm-MSDFit` algorithm:
-   - Added model selection to the :ref:`algm-MSDFit` algorithm, with three current models: MsdPeters, MsdYi and MsdPeters. New models now work with workspaces in Q not Q^2 (e.g. _eq workspaces 'Elastic Q').
+   - Added model selection to the :ref:`algm-MSDFit` algorithm, with three current models: :ref:`MsdGauss <func-MsdGauss>`, :ref:`MsdYi <func-MsdYi>`, and :ref:`MsdYi <func-MsdYi>`. New models now work with workspaces in :math:`Q` not :math:`Q^2` (e.g. _eq workspaces 'Elastic Q').
 - The following changes were made to the the :ref:`algm-ConvolutionFitSequential` algorithm:
    - Added 'ExtractMembers' property to :ref:`algm-ConvolutionFitSequential` - this allows for extracting the members of the convolution fitting into their own workspaces.
    - Property to pass the workspace index added to :ref:`algm-ConvolutionFitSequential`.

docs/source/release/v3.11.0/ui.rst

@@ -9,31 +9,30 @@ UI & Usability Changes
 User Interface
 --------------
 
-VSI Improvements
-################
+- Fixed the ability to drag & drop files into Mantid on OSX >=10.10
+- The welcome dialog has been redesigned to use less of the screen to fit better onto laptops with small high resolution screens that use screen scaling.
 
-- ParaView has been updated to to `v5.4.0 <https://blog.kitware.com/paraview-5-4-0-release-notes/>`_.
+Scanning workspaces
+###################
 
-.. figure:: ../../images/LaNaF4_3D_Slices.png
+- Choosing 'Show Detectors' for a workspace will now also show the time indexes for scanning workspaces.
+
+Workspace History Window
+########################
+
+.. figure:: ../../images/WorkspaceHistoryShortenedValues.png
    :class: screenshot
    :align: right
 
-- Upstream ParaView Contributions
-
- - Fix scaling, orientation and position inputs when nonorthogonal axes are present.
- - Speed up MultiSlice view by avoiding repeated allocating and freeing memory.
- - Fix the resample to image mapper, which was failing when input contains cell data.
- - Expose the SamplingDimensions property when using the resample to image mapper with vtkStructuredGrids.
+- Algorithm proprties with long values are now shown in a shortened format both in this display and the log.  The full history is still retained, and genereated python scripts will still work as before.
 
-- Upstream VTK Contributions
+Custom Interfaces
+#################
 
- - Improve surface filter performance using vtkSMPTools
- - Refactor the vtkDataSetTriangleFilter for better performance.
- - Refactor the threshold filter to take advantage of structured data.
- - Minimize duplicate code in vtkDataArrayPrivate and parallelize range calculation.
+- General > Multi dataset fitting interface and the general fitting dock now display the status string returned by the `Fit` algorithm. If an error occured during fitting it will be reported in this string.
+- Indirect ILL calibration tab, deprecated since v3.9 is now dropped.
+- SANS > ISIS SANS v2 experimental interface has become available. It has basic reduction functionalities and makes use of the new reduction backend.
 
-- Multislice view uses a custom `representation <https://www.paraview.org/ParaView/index.php/Views_And_Representations>`_ to speed up slicing by taking advantage of the consistent bin
-  sizes in a MDHistoWorkspace. Smooth interaction with typical data sizes (< 10 million cells) is now possible.
 
 SliceViewer Improvements
 ########################
@@ -42,26 +41,31 @@ SliceViewer Improvements
 - Fixed the ability to drag & drop files into Mantid OSX >=10.10
 - The welcome dialog has been redesigned to use less of the screen to fit better onto laptops with small high resolution screens that use screen scaling.
 
-Scanning workspaces
-###################
-
-- Choosing 'Show Detectors' for a workspace will now also show the time indexes for scanning workspaces.
+VSI Improvements
+################
 
-Workspace History Window
-########################
+- ParaView has been updated to to `v5.4.0 <https://blog.kitware.com/paraview-5-4-0-release-notes/>`_.
 
-.. figure:: ../../images/WorkspaceHistoryShortenedValues.png
+.. figure:: ../../images/LaNaF4_3D_Slices.png
    :class: screenshot
    :align: right
 
-- Algorithm proprties with long values are now shown in a shortened format both in this display and the log.  The full history is still retained, and genereated python scripts will still work as before.
+- Upstream ParaView Contributions
 
-Custom Interfaces
-#################
+  - Fix scaling, orientation and position inputs when nonorthogonal axes are present.
+  - Speed up MultiSlice view by avoiding repeated allocating and freeing memory.
+  - Fix the resample to image mapper, which was failing when input contains cell data.
+  - Expose the SamplingDimensions property when using the resample to image mapper with vtkStructuredGrids.
 
-- General > Multi dataset fitting interface and the general fitting dock now display the status string returned by the `Fit` algorithm. If an error occured during fitting it will be reported in this string.
-- Indirect ILL calibration tab, deprecated since v3.9 is now dropped.
-- SANS > ISIS SANS v2 experimental interface has become available. It has basic reduction functionalities and makes use of the new reduction backend.
+- Upstream VTK Contributions
+
+  - Improve surface filter performance using vtkSMPTools
+  - Refactor the vtkDataSetTriangleFilter for better performance.
+  - Refactor the threshold filter to take advantage of structured data.
+  - Minimize duplicate code in vtkDataArrayPrivate and parallelize range calculation.
+
+- Multislice view uses a custom `representation <https://www.paraview.org/ParaView/index.php/Views_And_Representations>`_ to speed up slicing by taking advantage of the consistent bin
+  sizes in a MDHistoWorkspace. Smooth interaction with typical data sizes (< 10 million cells) is now possible.
 
 Bugs Resolved
 -------------