diff --git a/Testing/Data/UnitTest/LARMOR00013065-add.nxs.md5 b/Testing/Data/UnitTest/LARMOR00013065-add.nxs.md5 deleted file mode 100644 index 3724fe80717f5576a57bb7c9f6aeb103cd4afb28..0000000000000000000000000000000000000000 --- a/Testing/Data/UnitTest/LARMOR00013065-add.nxs.md5 +++ /dev/null @@ -1 +0,0 @@ -0ad830e195879c54ff64583338d0e80a diff --git a/docs/source/concepts/ProjectRecovery.rst b/docs/source/concepts/ProjectRecovery.rst new file mode 100644 index 0000000000000000000000000000000000000000..0c31c3ad0795cc56b26081b0ac01ab19e659696f --- /dev/null +++ b/docs/source/concepts/ProjectRecovery.rst @@ -0,0 +1,71 @@ +.. _Project Recovery: + +Project Recovery +================ + +What is it? +----------- + +If Mantid crashes for some reason, we have introduced the functionality to attempt to recover the state that Mantid was in prior to the crash. + +Project recovery is a key part of our efforts to make Mantid as stable and reliable as possible. + +How it works +------------ + +Project recovery works in two parts: + +* History writer: This writes the history of the workspaces in your workspace dialog, periodically saving the files. It is not likely that you will ever notice the history writer process. +* Project recovery: This rebuilds the last saved state of Mantid after a crash, it uses the files produced by the history writer + +If Mantid has crashed, then on the subsequent reboot you will be presented with the project recovery dialog (see image) + +.. image:: ../images/ProjectRecoveryDialog.png + :width: 400px + :align: center + :alt: alternate text + +You can choose to attempt a full recovery, to open a recovery script or not to attempt a recovery. Full recovery will attempt to recover all workspaces present at the time of the crash as well as additional dialogs like plots or data windows. Script mode will attempt to construct a script that contains the history of all workspaces at the time of the crash. + +If full project recovery runs succesfully the scripting window will remain open in MantidPlot. It is safe to close this after a recovery. + +**NB** This is an early version of project recovery. We think that it is a lot better than nothing, but we know it won't always work. Known caveats are listed below. Moreover, we would sincerely appreciate feedback and input from users. Contact us at `mantid-help@mantidproject.org` + +The settings for project recovery, including switiching the feature on/off, and how to set them, are listed at the bottom of this page. + +Caveats +------- + +* Multiple instances of Mantid + * Please allow first instance to start history writer before starting the next instance, otherwise it will not start for either. This usually means leaving Mantid until the GUI has opened fully. + * Only the first instance will have history writer enabled. There will be no project recovery for subsequent instances. + * All running instances of Mantid must be closed for project recovery to work after a crash. + +* Interfaces + * Muon - project recovery does not work at all with the existing Muon interfaces. + * Indirect analysis - project recovery does not work when performing fitting routines within the indirect analysis interface. + * SANS - project recovery does not currently work with the SANS interface. + +* Multi-line commands + * Currently if a workspace history contains any multi-line commands then the recovery script builder will fail. + +* If full project recovery does not work: + * If the project recovery process has managed to create a script of the ordered workspace histories, this will appear in MantidPlot, it will have a red arrow beside the line where the process failed. In many cases it is possible to edit the script by hand to get it to run. + * If project recovery did not manage to generate the ordered history script then it will return to MantidPlot as normal, with an error message. + + +Settings +-------- + +* Project recovery behaviour can be edited by editing the `Mantid.user.properties` file + * Windows: `$MantidInstallDirectory\bin\Mantid.user.properties` + * OSX: `$HOME/.mantid/Mantid.user.properties` + * Linux:`$HOME/.mantid/Mantid.user.properties` + + +* Three settings you can add to this file: + * **On/off:** `projectRecovery.enabled=true` + * **Regularity:** `projectRecovery.secondsBetween = 60` + * **Number of backups to keep:** `projectRecovery.numberOfCheckpoints = 5` + +.. categories:: Concepts \ No newline at end of file diff --git a/docs/source/images/ProjectRecoveryDialog.png b/docs/source/images/ProjectRecoveryDialog.png new file mode 100644 index 0000000000000000000000000000000000000000..f21af61f7e938786301e92de7e97f516987efddb Binary files /dev/null and b/docs/source/images/ProjectRecoveryDialog.png differ diff --git a/docs/source/release/v3.13.0/direct_inelastic.rst b/docs/source/release/v3.13.0/direct_inelastic.rst index 067a2ec493b84a379e612fd54cfa265510ad8791..51ad9e074354592f98b3c2e8c8d382bc095b7f86 100644 --- a/docs/source/release/v3.13.0/direct_inelastic.rst +++ b/docs/source/release/v3.13.0/direct_inelastic.rst @@ -5,20 +5,14 @@ Direct Inelastic 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. - Interfaces ---------- - New ### - Added the ability to manually specify a temperature for a set of runs in the TOFTOF reduction dialog. - Improvements ############ @@ -26,7 +20,6 @@ Improvements - Workspaces used in MSlice are no longer added to the MantidPlot window automatically, and can be added using the ``Save To MantidPlot`` button. - Improved default limits for 2D plots of large datasets in MSlice. - Algorithms ---------- @@ -61,7 +54,6 @@ Deprecated Instrument Definitions ---------------------- - - The source component of ILL's IN5 has been moved from :math:`z = -2` to :math:`z = -2.10945` meters and renamed to ``frame-overlap_chopper``. - The source component of ILL's IN6 has been moved from :math:`z = -0.395` to :math:`z = -0.595` meters and renamed to ``suppressor_chopper``. - ILL's IN4 and IN6 now validate the wavelengths and chopper speeds in :ref:`MergeRuns <algm-MergeRuns>`. diff --git a/docs/source/release/v3.13.0/framework.rst b/docs/source/release/v3.13.0/framework.rst index 1b7b638a15f698727a5e7fd79ecf89df2d56eaf1..9d92983ad682b1eefd08c7ca32a38ad54636a03b 100644 --- a/docs/source/release/v3.13.0/framework.rst +++ b/docs/source/release/v3.13.0/framework.rst @@ -5,25 +5,24 @@ Framework 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. - Instrument Definition Updates ----------------------------- - The ALF IDF has been updated following a detector array alteration. - The LARMOR IDF has been updated following the addition of a new detector to the instrument. +- Instrument definition for IN4, 5, and 6 at the ILL have been updated +- REF_L and CNCS has update instrument files and EQSANS, REF_M, ARCS and CNCS are now configured for loading live data. Stability --------- +- We have introduced a Project Recovery mechanism for Mantidplot in order to be able to recover the lost state of the interface in the event of a crash or unexpected shutdown. There are more details in the UI section of the release notes. +- The error reporter can now catches hard crashes to desktop, allowing us to get more information on causes of hangs or crashes in Mantid. Since the last release error reports sent to us led directly to the identification of and fixes for 3 seperate bugs in Mantid. - Mantid now handles poor network stability better when reading live data from the ISIS DAE. Mantid will now timeout after a couple of minutes of loss of network connectivity and remains responsive during this time. You can alter the duration of this timeout by adding a line to the mantid.user.properties file like: ``` ISISDAE.Timeout = 100 #seconds ``` -- The error reporter now catches hard crashes to desktop. Algorithms @@ -32,10 +31,7 @@ Algorithms New ### -New Features -************ - -- A list of Related Algorithms has been added to each algorithm, and is displayed in the documentation page of each algorithm as part of it's summary. +- Sometimes the algorithm you are looking at is close to what you want, but not quite, to help you find the right one a list of Related Algorithms has been added to each algorithm, and is displayed in the documentation page of each algorithm as part of it's summary. New Algorithms ************** diff --git a/docs/source/release/v3.13.0/index.rst b/docs/source/release/v3.13.0/index.rst index 0e6f8aba5dbf1b8093a94ffd257aa20045775aa7..ee6ff739fa298440ce02bec1d1d8b516efffbe6c 100644 --- a/docs/source/release/v3.13.0/index.rst +++ b/docs/source/release/v3.13.0/index.rst @@ -7,6 +7,8 @@ Mantid 3.13.0 Release Notes .. figure:: ../../images/Release3-13.png :class: screenshot :align: right + + Mantid introduces project recovery for Mantidplot, Mantid maintains a recovery script while running, in the event of a crash or unexpected shutdown of Mantidplot Mantid will attempt to recover to it's most recent recovery checkpoint. .. contents:: Table of Contents :local: @@ -14,7 +16,14 @@ Mantid 3.13.0 Release Notes We are proud to announce version 3.13.0 of Mantid. -Here is a load of stuff we have done. +This release includes a first implementation of Project Recovery for Mantidplot to allow Mantid to handle scanning workspaces, Mantid maintains a recovery script while running, in the event of a crash or unexpected shutdown of Mantidplot Mantid will attempt to recover to it's most recent recovery checkpoint. This feature may not fully recover in all situations, but we will continue to improve it in future releases. There have also been some significant performance enhancements in the instrument view. + +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 +important changes and improvements in many areas. The development team +has put a great effort into making all of these improvements within +Mantid, and we would like to thank all of our beta testers for their +time and effort helping us to make this another reliable version of Mantid. Citation -------- diff --git a/docs/source/release/v3.13.0/reflectometry.rst b/docs/source/release/v3.13.0/reflectometry.rst index ef27f595abdafb3c371c26f72747532880457cdf..536f973c59699f4c76fb43ea2b577aa27eecd4dd 100644 --- a/docs/source/release/v3.13.0/reflectometry.rst +++ b/docs/source/release/v3.13.0/reflectometry.rst @@ -5,10 +5,6 @@ Reflectometry 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. - ISIS Reflectometry Interface ---------------------------- @@ -19,62 +15,54 @@ New - A new option has been added to the Settings tab to control whether partial bins should be included when summing in Q. - ``ReflectometryReductionOneAuto`` takes the polarization correction properties from the instrument parameter file when ``PolarizationAnalysis`` is set to ``ParameterFile``. The instrument parameter file can store the efficiencies as vectors of doubles. -Improvements -############ - -Bugfixes -######## - Features Removed ################ -* Added deprecation notice to ISIS Reflectometry (Old) due to be removed in March 2019. +* Added a deprecation notice to the ISIS Reflectometry (Old) interface, this is due to be removed in March 2019. It will be present in releases up until that date, but new features will only be added to the new interface. Algorithms ---------- -* Removed version 1 of ``ReflectometryReductionOne`` and ``ReflectometryReductionOneAuto``. -* Renamed algorithms ``PolarizationCorrection`` to ``PolarizationCorrectionFredrikze`` and ``PolarizationEfficiencyCor`` to ``PolarizationCorrectionWildes``. +- Removed version 1 of ``ReflectometryReductionOne`` and ``ReflectometryReductionOneAuto``. +- Renamed algorithms ``PolarizationCorrection`` to ``PolarizationCorrectionFredrikze`` and ``PolarizationEfficiencyCor`` to ``PolarizationCorrectionWildes``. New ### -* Added algorithm ``PolarizationEfficiencyCor`` which calls ``PolarizationCorrectionFredrikze`` or ``PolarizationCorrectionWildes`` depending on chosen ``Method`` property. -* Added algorithms that help create a matrix workspace with polarization efficiencies ready to be used with ``PolarizationEfficiencyCor`` +- Added algorithm ``PolarizationEfficiencyCor`` which calls ``PolarizationCorrectionFredrikze`` or ``PolarizationCorrectionWildes`` depending on chosen ``Method`` property. +- Added algorithms that help create a matrix workspace with polarization efficiencies ready to be used with ``PolarizationEfficiencyCor`` - ``CreatePolarizationEfficiencies`` creates efficiencies from polynomial coefficients - ``JoinISISPolarizationEfficiencies`` joins individual efficiencies into one matrix workspace - ``LoadISISPolarizationEfficiencies`` loads efficiencies form files -* The ILL reflectometry loader :ref:`algm-LoadILLReflectometry` implements the NeXus file changes of January 2018 and can load again all valid Nexus files for D17 and FIGARO which are available since 2013 and 2017, respectively. -* Algorithms for reflectometry reduction at ILL have been added. These handle the basic polarized/unpolarized reduction in SumInLambda or SumInQ modes. Included algorithms: - - :ref:`algm-ReflectometryILLPreprocess` - - :ref:`algm-ReflectometryILLSumForeground` - - :ref:`algm-ReflectometryILLPolarizationCor` - - :ref:`algm-ReflectometryILLConvertToQ` -* A new algorithm :ref:`algm-ReflectometryMomentumTransfer` provides conversion to momentum transfer and :math:`Q_{z}` resolution calculation for reflectivity workspaces. -* A new algorithm :ref:`ReflectometrySumInQ <algm-ReflectometrySumInQ>` is available for coherent summation of the reflected beam. +- The ILL reflectometry loader :ref:`algm-LoadILLReflectometry` implements the NeXus file changes of January 2018 and can load again all valid Nexus files for D17 and FIGARO which are available since 2013 and 2017, respectively. +- Algorithms for reflectometry reduction at ILL have been added. These handle the basic polarized/unpolarized reduction in SumInLambda or SumInQ modes. Included algorithms: -- :ref:`algm-ReflectometryReductionOne` and :ref:`algm-ReflectometryReductionOneAuto` no longer include partial bins by default when summing in Q. A new property, `IncludePartialBins`, has been added to re-enable partial bins. + - :ref:`algm-ReflectometryILLPreprocess` + - :ref:`algm-ReflectometryILLSumForeground` + - :ref:`algm-ReflectometryILLPolarizationCor` + - :ref:`algm-ReflectometryILLConvertToQ` +- A new algorithm :ref:`algm-ReflectometryMomentumTransfer` provides conversion to momentum transfer and :math:`Q_{z}` resolution calculation for reflectivity workspaces. +- A new algorithm :ref:`ReflectometrySumInQ <algm-ReflectometrySumInQ>` is available for coherent summation of the reflected beam. -Improvements -############ +- :ref:`algm-ReflectometryReductionOne` and :ref:`algm-ReflectometryReductionOneAuto` no longer include partial bins by default when summing in Q. A new property, `IncludePartialBins`, has been added to re-enable partial bins. - Added a boolean property ``Debug`` to the reflectometry algorithms that controls output of additional and/or intermediate workspaces. Bug fixes ######### -* Correct the angle to the value of ``ThetaIn`` property if summing in lambda in ``ReflectometryReductionOne-v2``. -* Fixed an incorrectly calculated detector angle when loading FIGARO files using :ref:`algm-LoadILLReflectometry`. +- Correct the angle to the value of ``ThetaIn`` property if summing in lambda in ``ReflectometryReductionOne-v2``. +- Fixed an incorrectly calculated detector angle when loading FIGARO files using :ref:`algm-LoadILLReflectometry`. Liquids Reflectometer --------------------- -* New REF_L instrument geometry for 2018 run cycle. +- New REF_L instrument geometry for 2018 run cycle. Magnetism Reflectometer ----------------------- -* Added live data information to Facilities.xml -* Allow for the use of workspace groups as input to the reduction. -* Added algorithm to compute scattering angle from a workspace. +- Added live data information to Facilities.xml +- Allow for the use of workspace groups as input to the reduction. +- Added algorithm to compute scattering angle from a workspace. :ref:`Release 3.13.0 <v3.13.0>` diff --git a/docs/source/release/v3.13.0/sans.rst b/docs/source/release/v3.13.0/sans.rst index 351fe2e48ef14842d2829f643ecaa39735a5d289..2981b0ce176b8535be28f670719e61d9f2ec30d1 100644 --- a/docs/source/release/v3.13.0/sans.rst +++ b/docs/source/release/v3.13.0/sans.rst @@ -5,12 +5,18 @@ SANS Changes .. contents:: Table of Contents :local: +ILL +--- + * :ref:`LoadILLSANS <algm-LoadILLSANS>` is upgraded to load the modern nexus files from instruments D11, D22 and D33 at the ILL. + +SNS +--- + * EQSANS is configured for live data ISIS SANS Interface ----------------------------- - +------------------- New ### * A string of wavelength ranges can now be specified. A reduction is then done for each wavelength range.