diff --git a/docs/source/release/v4.2.0/diffraction.rst b/docs/source/release/v4.2.0/diffraction.rst index bd6fbdef197799efbb53a5390d83d391f19f6c2c..e834fbfde6708225ddf4f2e3512e413c6c4c264d 100644 --- a/docs/source/release/v4.2.0/diffraction.rst +++ b/docs/source/release/v4.2.0/diffraction.rst @@ -35,7 +35,7 @@ Bug Fixes :width: 500px :align: right -.. figure:: ../../images/IndexPeaks.png +.. figure:: ../../images/IndexPeaks.PNG :class: screenshot :width: 500px :align: right @@ -63,6 +63,6 @@ Bug Fixes so that it correctly reports the number of main & satellite reflections that have been indexed. Also, if a satellite peak cannot be indexed its HKL is reset to 000 rather than accidentally setting it to the HKL of the main reflection. -``*``See associated photos +``*`` See associated photos ``*`` :ref:`Release 4.2.0 <v4.2.0>` diff --git a/docs/source/release/v4.2.0/direct_geometry.rst b/docs/source/release/v4.2.0/direct_geometry.rst index a8ea508cf6312fd93f5430a090b5ada5210c7b6b..c3817f51d54cd93416d8bb4fcea6eb00214cb5db 100644 --- a/docs/source/release/v4.2.0/direct_geometry.rst +++ b/docs/source/release/v4.2.0/direct_geometry.rst @@ -14,9 +14,9 @@ Algorithms ########## - :ref:`DirectILLApplySelfShielding <algm-DirectILLApplySelfShielding>` will now first subtract the empty container background, then apply the self-shielding correction of the sample. -- Modified :ref:`MaskBTP <algm-MaskBTP-v1>`to include CHESS +- Modified :ref:`MaskBTP <algm-MaskBTP-v1>` to include CHESS -.. figure:: ../../images/CHESS.png +.. figure:: ../../images/CHESS.PNG :class: screenshot :width: 200px :align: right diff --git a/docs/source/release/v4.2.0/framework.rst b/docs/source/release/v4.2.0/framework.rst index 2d835d6e77f56e30dff70066cce868612baa9b1e..c45601aca79552afd1c206de8ddb31624547dd3c 100644 --- a/docs/source/release/v4.2.0/framework.rst +++ b/docs/source/release/v4.2.0/framework.rst @@ -9,6 +9,7 @@ Framework Changes :class: screenshot :width: 385px :align: right + Packaging ######### - The macOS bundle now requires macOS High Sierra (10.13) as a minimum. diff --git a/docs/source/release/v4.2.0/indirect_geometry.rst b/docs/source/release/v4.2.0/indirect_geometry.rst index 3f44f1e8fd917ce938bca0e3e6ccfaaea78007e0..15281bf557f93986f641f387072e69af703907b7 100644 --- a/docs/source/release/v4.2.0/indirect_geometry.rst +++ b/docs/source/release/v4.2.0/indirect_geometry.rst @@ -5,97 +5,53 @@ Indirect Geometry Changes .. contents:: Table of Contents :local: -.. warning:: **Developers:** Sort changes under appropriate heading - putting new features at the top of the section, followed by - improvements, followed by bug fixes. - -Improved -######## - -- Instrument definition is improved for IN16B to have the physical detector on the correct side of the beam axis, and different analyser focus for single detectors. -- :ref:`LoadILLIndirect <algm-LoadILLIndirect>` is extended to support also the configurations with the first tube angle at 33.1 degrees. -- :ref:`IndirectILLEnergyTransfer <algm-IndirectILLEnergyTransfer>` now offers the possibility to enable or disable the detector grouping both for Doppler and BATS modes. By default the pixels will be grouped tube by tube as before. -- :ref:`IndirectILLEnergyTransfer <algm-IndirectILLEnergyTransfer>` offers an option to discard the single detectors if they were not enabled in the measurement. -- A bug has been fixed in :ref:`MatchPeaks <algm-MatchPeaks>` which was causing wrong alignment in :ref:`IndirectILLReductionQENS <algm-IndirectILLReductionQENS>` with unmirror option 7, when the peaks in the alignment run are too narrow to be fitted. -- :ref:`SofQWNormalisedPolygon <algm-SofQWNormalisedPolygon>` now checks input properties are valid. -- :ref:`IndirectILLReductionFWS <algm-IndirectILLReductionFWS>` will now integrate the inelastic peaks correctly, based on the peak positions in the monitor spectrum. - - -Algorithms ----------- Improvements ############ -- :ref:`IndirectQuickRun <algm-IndirectQuickRun>` and :ref:`IndirectSampleChanger <algm-IndirectSampleChanger>` have been - extended to allow them to perform a Width Fit. This utilizes the new algorithm :ref:`IndirectTwoPeakFit <algm-IndirectTwoPeakFit>`. - -Data Analysis Interface ------------------------ - -Improvements -############ -- Improved the output plotting options for Elwin and Iqt so that it is now possible to choose - a list of spectra for plotting. For example, entering 0-2,4,6-8 and clicking **Plot Spectra** +- Instrument definition is improved for IN16B to have the physical detector on the correct side of the beam axis, and different analyser focus for single detectors. +- Able to choose a list of spectra for plotting for all Indirect Interfaces. +For example, under Data Analysis>Elwin, entering 0-2,4,6-8 and clicking **Plot Spectra** will plot the workspace indices 0, 1, 2, 4, 6, 7 and 8. The same can be done for **Plot Tiled** - on the Iqt tab. + on the Iqt tab. It also possible to produce a contour plot using **Plot Contour** on the Diffraction Interface. +- The Plotting Options have also been made more consistent across the interface. +.. figure:: ../../images/Indirect_Data_Analysis_IqtFit.PNG + :class: screenshot + :align: right + :figwidth: 60% + :alt: The Indirect Data Analysis GUI in the Workbench. -Data Reduction Interface ------------------------- - -Improvements -############ -- Improved the output plotting options so that it is now possible to choose a list of spectra - for plotting. This is the same as described for the Elwin and Iqt tab in Data Analysis. -- Improved the output plotting options so that they now show the workspace currently selected. - The options have also been made more consistent across the interface. +Workbench +------------- +- The Indirect Bayes GUI has been added to the Workbench. +- ``*``**The Indirect Data Analysis GUI has been added to the Workbench**``*`` -Data Corrections Interface --------------------------- +Algorithms +---------- -Improvements -############ -- Improved the output plotting options so that it is now possible to choose a list of spectra - for plotting. -- Improved the output plotting options so that they now show the workspace currently selected. - The options have also been made more consistent across the interface. +- :ref:`IndirectQuickRun <algm-IndirectQuickRun>` and :ref:`IndirectSampleChanger <algm-IndirectSampleChanger>` have been + extended to allow them to perform a Width Fit. This utilizes the new algorithm :ref:`IndirectTwoPeakFit <algm-IndirectTwoPeakFit>`. +- :ref:`LoadILLIndirect <algm-LoadILLIndirect>` is extended to support also the configurations with the first tube angle at 33.1 degrees. +- :ref:`IndirectILLEnergyTransfer <algm-IndirectILLEnergyTransfer>` now offers the possibility to enable or disable the detector grouping both for Doppler and BATS modes. By default the pixels will be grouped tube by tube as before. +- :ref:`IndirectILLEnergyTransfer <algm-IndirectILLEnergyTransfer>` offers an option to discard the single detectors if they were not enabled in the measurement. +- :ref:`SofQWNormalisedPolygon <algm-SofQWNormalisedPolygon>` now checks input properties are valid. +- :ref:`IndirectILLReductionFWS <algm-IndirectILLReductionFWS>` will now integrate the inelastic peaks correctly, based on the peak positions in the monitor spectrum. Simulations Interface --------------------- -Improvements -############ -- Improved the output plotting options so that it is now possible to choose a list of spectra - for plotting for the relevant tabs. -- Improved the output plotting options so that they now show the workspace currently selected. - The options have also been made more consistent across the interface. - Improved the format of Abins HDF5 files to include readable set of advanced parameters. Values in the AbinsParameters module have been re-organised into a logical heirarchy; user scripts may need to be modified to match this. +BugFixes +######## -Diffraction Interface ---------------------- - -Improvements -############ -- Improved the output plotting options so that it is now possible to choose a list of spectra - for plotting. It also possible to do a contour plot using **Plot Contour**. -- Improved the output plotting options so that they now show the workspace currently selected. - -The Workbench -------------- - -- The Indirect Bayes GUI has been added to the Workbench. -- The Indirect Data Analysis GUI has been added to the Workbench. +- A bug has been fixed in :ref:`MatchPeaks <algm-MatchPeaks>` which was causing wrong alignment in :ref:`IndirectILLReductionQENS <algm-IndirectILLReductionQENS>` with unmirror option 7, when the peaks in the alignment run are too narrow to be fitted. -.. figure:: ../../images/Indirect_Data_Analysis_IqtFit.PNG - :class: screenshot - :align: center - :figwidth: 90% - :alt: The Indirect Data Analysis GUI in the Workbench. +``*`` See associated image ``*`` :ref:`Release 4.2.0 <v4.2.0>` diff --git a/docs/source/release/v4.2.0/mantidworkbench.rst b/docs/source/release/v4.2.0/mantidworkbench.rst index a878a894b5fc624a812b3c3220a0e7826d9fbf02..ea49050e9eac9bff2630e8c96605103f8f5915b8 100644 --- a/docs/source/release/v4.2.0/mantidworkbench.rst +++ b/docs/source/release/v4.2.0/mantidworkbench.rst @@ -109,6 +109,6 @@ Bugfixes - The button to "Remove" a curve in Figure Options is now the same size as the drop-down list of curves. - "MantidPlot" in window titles have been removed. -``*``Bold: See associated image +``*`` See associated image ``*`` :ref:`Release 4.2.0 <v4.2.0>`