Final changes for release notes 6.11

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

@@ -10,13 +10,13 @@ Powder Diffraction
 
 New features
 ############
+- :ref:`HRPD reduction scripts <isis-powder-diffraction-hrpd-ref>` now support the boolean option ``fit_prompt_pulse`` to fit and subtract prompt pulse (as opposed to the default method of masking of prompt pulse in TOF).
+  You can either specify this option in the configuration file or with ``hrpd.HRPD(fit_prompt_pulse=True)``.
 - Algorithm :ref:`AlignAndFocusPowder <algm-AlignAndFocusPowder>` now supports logarithmic compression.
+- Algorithm :ref:`SNSPowderReduction <algm-SNSPowderReduction>` now takes advantage of a new logarithmic compression technique in :ref:`AlignAndFocusPowderFromFiles <algm-AlignAndFocusPowderFromFiles>` and :ref:`AlignAndFocusPowder <algm-AlignAndFocusPowder>`.
 - Algorithm :ref:`AlignAndFocusPowderFromFiles <algm-AlignAndFocusPowderFromFiles>` now takes advantage of a new compression technique in :ref:`LoadEventNexus <algm-LoadEventNexus>` and :ref:`AlignAndFocusPowder <algm-AlignAndFocusPowder>`.
-- Algorithm :ref:`SNSPowderReduction <algm-SNSPowderReduction>` now takes advantage of a new compression technique in :ref:`AlignAndFocusPowderFromFiles <algm-AlignAndFocusPowderFromFiles>` and :ref:`AlignAndFocusPowder <algm-AlignAndFocusPowder>`.
 - Algorithm :ref:`LoadEventAndCompress <algm-LoadEventAndCompress>` now takes advantage of a new compression technique in :ref:`LoadEventNexus <algm-LoadEventNexus>`.
 - Algorithms :ref:`FitPeaks <algm-FitPeaks>` and :ref:`PDCalibration <algm-PDCalibration>` now do a check after the fit for the minimum signal-to-sigma ratio, where peaks with a signal below the provided threshold will be rejected.
-- :ref:`HRPD reduction scripts <isis-powder-diffraction-hrpd-ref>` now support the boolean option ``fit_prompt_pulse`` to fit and subtract prompt pulse (as opposed to the default method of masking of prompt pulse in TOF).
-  You can either specify this option in the configuration file or with ``hrpd.HRPD(fit_prompt_pulse=True)``.
 
 Bugfixes
 ############
@@ -45,6 +45,7 @@ Single Crystal Diffraction
 
 New features
 ############
+- New algorithm :ref:`RotateSampleShape <algm-rotatesampleshape>` that defines the initial orientation of a sample with respect to the beam and instrument.
 - :ref:`IntegratePeaksSkew <algm-IntegratePeaksSkew>` is better at determining background bins by minimising third-moment (skew).
   This is achieved by forcing skew > 0 (minimum skew we would expect in background).
   This change stops peak mask of :ref:`IntegratePeaksSkew <algm-IntegratePeaksSkew>` including too many pixels due to small diffuse scattering:
@@ -75,15 +76,15 @@ New features
 .. figure::  ../../images/6_11_release/FindMultipleUMatrices.png
    :width: 400px
 
-- Algorithm :ref:`ShowPossibleCells <algm-ShowPossibleCells>` now has a new output property, ``Cells``, that includes the cell information in a usable way.
+- Algorithm :ref:`ShowPossibleCells <algm-ShowPossibleCells>` now has a new output property, ``Cells``, that includes the cell information.
 - New algorithm :ref:`SaveMDHistoToVTK <algm-SaveMDHistoToVTK>` that saves a :ref:`MDHistoWorkspace <MDHistoWorkspace>` as a ``VTK`` file so that it can be visualized by ``Paraview``.
 - :ref:`IntegratePeaksShoeboxTOF <algm-IntegratePeaksShoeboxTOF>` has improved optimisation for shoebox position - would previously be centred on nearby stronger peaks if present.
-- Execution time of :ref:`IntegratePeaks1DProfile <algm-IntegratePeaks1DProfile>` has been sped up by an order of magnitude.
+- Execution time of :ref:`IntegratePeaks1DProfile <algm-IntegratePeaks1DProfile>` has improved by a factor of ten.
 
 
 Bugfixes
 ############
-- :ref:`LoadWANDSCD <algm-LoadWANDSCD>` now keeps the sgl/sgu angles set by the goniometer.
+- :ref:`LoadWANDSCD <algm-LoadWANDSCD>` now keeps the ``sgl`` and ``sgu`` angles set by the goniometer.
 - :ref:`ConverWANDSCDToQ <algm-ConvertWANDSCDToQ>` simplifies the underlying code by using histograms directly.
 
 :ref:`Release 6.11.0 <v6.11.0>`

docs/source/release/v6.11.0/direct_geometry.rst

@@ -21,15 +21,30 @@ New features
 Bugfixes
 ############
 - :ref:`ALFView <ALFView-ref>` no longer crashs when moving the cursor over the Instrument View while loading data.
+- :ref:`ALFView <ALFView-ref>` no longer crashes when closing the interface while it is loading data.
 - :ref:`PyChop` no longer uses random phase values on Merlin when instrument scientist mode disabled.
+- Fix for incorrect incident energies for ``MERLIN`` in :ref:`PyChop` when not in instrument scientist mode.
 
 
+MSlice
+------
+
+New features
+############
+- ``None`` is now a new line style option. With this feature, it is possible to plot error bars without including a line.
+- The spectrum ID is no longer printed when saving a 2D workspace as an ASCII file.
+
+Bugfixes
+########
+- The ``Intensity`` menu on slice plots is now disabled in interactive mode to prevent crashes.
+- Bug fix implemented to save cut data in a 3-column file instead of a single line.
+
 CrystalField
 -------------
 
 Bugfixes
 ############
-- The method `cf.getMagneticMoment()` no longer ignores the `Hmag` field, which is now
+- The method ``cf.getMagneticMoment()`` no longer ignores the ``Hmag`` field, which is now
   correctly considered in the calculations of the magnetic moment.
 
 

docs/source/release/v6.11.0/framework.rst

@@ -10,26 +10,28 @@ Algorithms
 
 New features
 ############
+- There is a new :ref:`Deprecation Policy <deprecation_policy>` for Mantid.
 - Errors due to H5 file exceptions are now caught with improved error reporting.
 - Algorithm :ref:`algm-Load` will now give a warning if the extension specified on the filename, eg. `MUSR15189.txt`, is not found.
   Loading files from interfaces or other algorithms should also give this warning.
   The algorithm will still load the file by looking for other extensions, as was the case before.
-- A new version of :ref:`GenerateGroupingPowder <algm-GenerateGroupingPowder>` (version 2) that will save the grouping file with groups starting at 1 instead of 0 to make them consisted with ``GroupingWorkspace``.
+- A new version of :ref:`GenerateGroupingPowder <algm-GenerateGroupingPowder>` (version 2) that will save the grouping file with groups starting at 1 instead of 0 to make them consistent with ``GroupingWorkspace``.
   The ``FileFormat`` parameter has also been removed as it will now be determined from the extension of ``GroupingFilename``.
 - Algorithm :ref:`LoadEventNexus <algm-LoadEventNexus>` now has a new ``FilterBadPulsesLowerCutoff`` parameter that implements the functionality of :ref:`FilterBadPulses <algm-FilterBadPulses>`.
 - Algorithm :ref:`algm-PolarizationCorrectionWildes` and :ref:`algm-PolarizationEfficiencyCor` have a new ``SpinStates`` property to allow the order of the workspaces in the output workspace group to be set.
 - Algorithm :ref:`algm-CombineDiffCal` has improved time-scaling performance and new extra validations.
 - Algorithm :ref:`CompareWorkspaces <algm-CompareWorkspaces>` now supports :ref:`Ragged Workspaces <Ragged_Workspace>`.
 - Binary operations :ref:`Plus <algm-Plus>`, :ref:`Minus <algm-Minus>`, :ref:`Divide <algm-Divide>` and :ref:`Multiply <algm-Multiply>` now support :ref:`Ragged Workspaces <Ragged_Workspace>`.
-- Algorithm :ref:`CompressEvents <algm-CompressEvents>` a new ``SortFirst`` property that controls whether sorting happens before compressing events.
+- Algorithm :ref:`CompressEvents <algm-CompressEvents>` has the new property ``SortFirst`` that controls whether sorting happens before compressing events.
   If ``SortFirst=False`` then a different method is used to compress events that will not sort first. This is faster when you have a large number of events per compress tolerance.
 - Algorithm :ref:`ISISIndirectEnergyTransfer <algm-ISISIndirectEnergyTransfer>` has the new property ``OutputSuffix`` that will append a suffix to the end of output workspace names.
 - Algorithms :ref:`AlignAndFocusPowderFromFiles <algm-AlignAndFocusPowderFromFiles>` and ref: :ref:`SNSPowderReduction <algm-SNSPowderReduction>` have new a property called ``MinSizeCompressOnLoad`` for specifying load compression.
 - Algorithm :ref:`NMoldyn4Interpolation <algm-NMoldyn4Interpolation>` now uses ``scipy.interpolate.RectBivariateSpline`` instead of ``scipy.interpolate.interp2d``, since ``interp2d`` has been removed in version 1.14 of ``scipy``.
   See reference documentation here (https://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.interp2d.html).
 - Algorithm :ref:`DiscusMultipleScatteringCorrection <algm-DiscusMultipleScatteringCorrection-v1>` now supports a radial collimator that restricts scatter points within a small region within the larger sample volume.
   The algorithm was modified to assign zero weight to tracks where the final scatter is not in a position that allows the final track segment to pass through the collimator toward detectors.
-- Version 2 of the algorithm :ref:`LoadEventAsWorkspace2D <algm-LoadEventAsWorkspace2D>` that adds the property ``FilterByTime``.
+- Algorithm :ref:`LoadEventAsWorkspace2D <algm-LoadEventAsWorkspace2D>` has been updated to version 2.
+  This update adds the new property ``FilterByTime``.
 - New algorithm :ref:`ScaleInstrumentComponent <algm-ScaleInstrumentComponent>` to scale all detectors in an instrument component around the component's geometrical position.
 
 .. figure::  ../../images/6_11_release/ScaleInstrumentComponent.png
@@ -75,7 +77,7 @@ Data Objects
 
 Bugfixes
 ############
-- Added a `+ 1` to `EventWorkspace::sortAll` to prevent grainsize from being 0.
+- Added a ``+ 1`` to ``EventWorkspace::sortAll`` to prevent grainsize from being 0.
 - Loading ``ENGIN-X`` data on IDAaaS from the instrument data cache no longer throws a ``path not found`` error.
 
 
@@ -88,6 +90,9 @@ New features
 - Fix python fuction ``assert_almost_equal`` to fail for non-equal workspaces.
 - The python function ``assert_almost_equal`` for testing if two modules are within a tolerance was reworked.
 
+Bugfixes
+############
+- Fixed error in the log about ``load_module()`` being deprecated in Python 3.12.
 
 Dependencies
 ------------------
@@ -101,7 +106,7 @@ Bugfixes
 ############
 - Introduced a run constraint to the mantid package to constrain the optional matplotlib dependency to v3.7.
   Previously it was possible to install any version of matplotlib alongside mantid in a conda environment, but we cannot guarantee compatibility for any version other than 3.7.
-- Versions of `pycifrw` are now allowed to be greater than 4.4.1.
+- Versions of ``pycifrw`` are now allowed to be greater than 4.4.1.
 
 
 MantidWorkbench

docs/source/release/v6.11.0/index.rst

@@ -5,20 +5,20 @@ Mantid 6.11.0 Release Notes
 ===========================
 
 .. figure::  ../../images/6_11_release/single-crystal-peak-background-edited.png
-   :width: 500px
+   :width: 400px
    :class: screenshot
    :align: right
 
 .. contents:: Table of Contents
    :local:
 
-.. warning:: This release is still under construction. The changes can be found in the nightly builds on the `download page`_.
-
 We are proud to announce version 6.11.0 of Mantid.
 
 In this release we gave extra attention to fixing bugs and improving algorithms (for example by making them run faster or use less memory).
 We also added several new algorithms. These are the highlights for this release:
 
+- There is a new :ref:`Deprecation Policy <deprecation_policy>` for Mantid.
+  One of the main changes is that we will deprecate algorithms that have not been used for 3 years or more.
 - For single crystal diffraction, we added a new algorithm :ref:`FindMultipleUMatrices <algm-FindMultipleUMatrices>`
   to find multiple UB matrices when given lattice parameters for sample with multiple domains or spurious peaks.
 - Also for single crystal diffraction,  :ref:`IntegratePeaksSkew <algm-IntegratePeaksSkew>` is better at determining background bins by minimising third-moment (skew).
@@ -30,11 +30,14 @@ We also added several new algorithms. These are the highlights for this release:
   :ref:`SNSPowderReduction <algm-SNSPowderReduction>` and
   :ref:`LoadEventAndCompress <algm-LoadEventAndCompress>`
   were updated to use logarithmic compression, which uses less memory.
-- For reflectometry, we added a new algorithm :ref:`algm-PolarizationEfficienciesWildes` has been added for calculating the efficiencies of the polarizing components of an instrument with two flippers.
-  This algorithm implements the approach from the A. R. Wildes 2006 paper.
+- For reflectometry, we added a new algorithm :ref:`algm-PolarizationEfficienciesWildes` for calculating the efficiencies of the polarizing components of an instrument with two flippers.
+  This algorithm implements the approach from the A. R. Wildes 2006 paper `doi: 10.1080/10448630600668738 <https://doi.org/10.1080/10448630600668738>`_.
 - For SANS, we added new algorithm :ref:`PolarizerEfficiency <algm-PolarizerEfficiency-v1>` for calculating the efficiency of a polariser.
-
-- Mantid developer environments are now created using a new ``mantid-developer`` Conda meta-package, hosted on our Conda channel.
+- For Inelastic, renamed tabs of :ref:`QENS Fitting <interface-inelastic-qens-fitting>` from ``MSD Fit``, ``I(Q,t) Fit``, ``ConvFit`` and ``F(Q)`` to ``MSD``, ``I(Q,t)``, ``Convolution`` and ``Function(Q)`` respectively.
+- For Inelastic, the :ref:`Elwin Tab <elwin>` of  :ref:`Data Processor Interface <interface-inelastic-data-processor>` now includes access to the Slice Viewer or 3D Plot from the output plot widget of the output workspaces containing more than 1 histogram.
+- Again for Inelastic, :ref:`QENS Fitting Interface <interface-inelastic-qens-fitting>` now allows loading a ``_Result`` workspace from the ``I(Q, t)`` fitting tab into the ``Function (Q)`` fitting tab if one of the fit parameters is A0.
+- Finally, for developers, the Mantid developer environments are now created using a new ``mantid-developer`` Conda meta-package, hosted on our Conda channel.
+  This change does not affect users but greatly simplifies our development process, as package dependencies are now automatically sorted on different operating systems.
 
 These are just some of the many improvements in this release, so please take a
 look at the release notes, which are filled with details of the

docs/source/release/v6.11.0/inelastic.rst

@@ -12,10 +12,14 @@ New Features
 .. figure::  ../../images/6_11_release/load_history_option.png
    :width: 500px
 
-- The :ref:`Elwin Tab <elwin>` of  :ref:`Data Processor Interface <interface-inelastic-data-processor>` now includes access the Slice Viewer or 3D Plot from the ``OutputPlot`` widget of the output workspaces containing more than 1 histogram.
+- The :ref:`Elwin Tab <elwin>` of  :ref:`Data Processor Interface <interface-inelastic-data-processor>` now includes access to the Slice Viewer or 3D Plot from the output plot widget of the output workspaces containing more than 1 histogram.
+
+.. figure::  ../../images/6_11_release/elwin_plot_3D.gif
+   :width: 500px
+
 - The :ref:`Convolution <convfit>` tab of the :ref:`Inelastic QENS Fitting Interface <interface-inelastic-qens-fitting>` now has option ``Tie Peak Centres`` to tie two Lorentzians in the interface.
-- The ``Function (Q)`` tab of the :ref:`QENS Fitting Interface <interface-inelastic-qens-fitting>` now allows to load `A0` fit parameter data into the interface.
-- The ``I(Q, t)`` tab in :ref:`Inelastic QENS Fitting Interface <interface-inelastic-qens-fitting>` has new option `Output Composite Members`.
+- :ref:`QENS Fitting Interface <interface-inelastic-qens-fitting>` now allows loading a ``_Result`` workspace from the ``I(Q, t)`` fitting tab into the ``Function (Q)`` fitting tab if one of the fit parameters is A0.
+- The ``I(Q, t)`` tab in :ref:`Inelastic QENS Fitting Interface <interface-inelastic-qens-fitting>` has new option ``Output Composite Members``.
 - Renamed tabs of :ref:`QENS Fitting <interface-inelastic-qens-fitting>` from ``MSD Fit``, ``I(Q,t) Fit``, ``ConvFit`` and ``F(Q)`` to ``MSD``, ``I(Q,t)``, ``Convolution`` and ``Function(Q)`` respectively. Added tooltip.
 
 .. figure::  ../../images/6_11_release/renamed_tabs.png
@@ -29,10 +33,11 @@ Bugfixes
 - Algorithm :ref:`BayesQuasi <algm-BayesQuasi>` no longer throws an ``index out of range`` error when using a sample with a numeric axis.
 - The :ref:`Elwin Tab <elwin>` of the :ref:`Data Processor Interface <interface-inelastic-data-processor>` no longer freezes when running the tab.
 - The :ref:`Convolution <convfit>` of the :ref:`QENS Fitting interface <interface-inelastic-qens-fitting>` no longer crashes when attempting to fix all ``IsoDiffRot`` parameters from the ``EditLocalParameter`` dialog.
-- When the ADS is cleared of workspaces that are used to run fits on an open :ref:`QENS Fitting interface <interface-inelastic-qens-fitting>`, a warning message now pops up when clicking on the `Run` button.
+- When the ADS is cleared of workspaces that are used to run fits on an open :ref:`QENS Fitting interface <interface-inelastic-qens-fitting>`, a warning message now pops up when clicking on the ``Run`` button.
 - Fixed a bug in the Monte Carlo error calculation on the I(Q, t) tab of the :ref:`Data Processor Interface <interface-inelastic-data-processor>` where the first bin had an error of zero.
 - The :ref:`Elwin Tab <elwin>` of the :ref:`Data Processor Interface <interface-inelastic-data-processor>` now supports loading data unrestricted by suffix if the option is selected from ``Settings``.
-- The :ref:`Elwin interface <elwin>` now allows to see the Spectrum number 0 on the widget plot of the selected preview workspace.
+- On :ref:`Elwin interface <elwin>`, it is now possible to see the spectrum number 0 on the widget plot of the selected preview workspace.
+  Changing the preview spectrum above the plot widget combo box now plots the correct spectrum for the selected index.
 - The :ref:`Elwin interface <elwin>` now plots the correct spectrum for the selected index when changing the preview spectrum above the plot widget combo box.
 - The :ref:`Moments<inelastic-moments>` tab of the :ref:`Data Processor <interface-inelastic-data-processor>` interface now have responsive sliders to changes in ``Emin`` and ``EMax`` properties when changed from the property browser.
 - The :ref:`Inelastic Bayes fitting <interface-inelastic-bayes-fitting>` interface now correctly calculates EISF errors on the Quasi tab.
@@ -43,6 +48,7 @@ Bugfixes
 - Fixed a crash on the Quasi tab of the :ref:`Inelastic Bayes Fitting <interface-inelastic-bayes-fitting>` interface caused by attempting to load a WorkspaceGroup rather than the expected Workspace2D.
 - Prevented a crash on the Quasi tab of the :ref:`Inelastic Bayes Fitting <interface-inelastic-bayes-fitting>` interface caused by clicking ``Run`` before data has finished loading.
 - Available fit functions in the ``Function (Q)`` tab of the :ref:`QENS Fitting <interface-inelastic-qens-fitting>` interface are now updated according to the type of data (``EISF``, ``A0`` or ``Width``) loaded in the table.
+- :ref:`Inelastic Bayes Fitting <interface-inelastic-bayes-fitting>` no longer crashes when closing the interface while it is loading data.
 
 
 Algorithms