.. warning:: **Developers:** Sort changes under appropriate heading
putting new features at the top of the section, followed by
improvements, followed by bug fixes.
.. figure:: ../../images/UpdateOS.png
:class: screenshot
:width: 385px
:align: right
Packaging
---------
* The macOS bundle now requires macOS High Sierra (10.13) as a minimum.
#########
- The macOS bundle now requires macOS High Sierra (10.13) as a minimum.
- The Ubuntu bundle requires Ubuntu 18.04.
- Although this release may continue to work on Windows 7/8, this will not have been verified or tested by the development team on anything earlier than Windows 10.
Concepts
--------
New
###
Algorithms
----------
* :ref:`LoadNGEM <algm-LoadNGEM>` added as a loader for the .edb files generated by the nGEM detector used for diagnostics. Generates an event workspace.
* :ref:`MaskAngle <algm-MaskAngle>` has an additional option of ``Angle='InPlane'``
* :ref:`FitIncidentSpectrum <algm-FitIncidentSpectrum>` will fit a curve to an incident spectrum returning the curve and it's first derivative.
* :ref:`CalculatePlaczekSelfScattering <algm-CalculatePlaczekSelfScattering>` will calculate the Placzek correction from an incident spectrum as generated by :ref:`FitIncidentSpectrum <algm-FitIncidentSpectrum>`.
* Whitespace is now ignored anywhere in the string when setting the Filename parameter in :ref:`Load <algm-Load>`.
* Added options to :ref:`SaveMD <algm-SaveMD>` to allow selection of what will be saved. For MDHistoWorkspace only.
* :ref:`SetGoniometer <algm-SetGoniometer>` will now work on all workspaces not just Workspace2D.
* A new Poisson cost function has been added to :ref:`CalculateCostFunction <algm-CalculateCostFunction>`.
* New algorithm :ref:`SaveNexusESS <algm-SaveNexusESS>` to save data and nexus geometry to a single processed file.
* Version upgrade :ref:`LoadNexusProcessed <algm-LoadNexusProcessed>` to allow loading of both existing Mantid format Processed Nexus files and those produced via :ref:`SaveNexusESS <algm-SaveNexusESS>`.
* In :ref:`SaveAscii <algm-SaveAscii>` it is now possible to save out also the values of the spectrum axis.
* :ref:`IndexPeaks <algm-IndexPeaks>` now has options to enter modulation vectors and additional information required for satellite peak indexing. As
a result :ref:`IndexPeaksWithSatellites <algm-IndexPeaksWithSatellites>` has been deprecated and will be removed in a future release.
- :ref:`SaveNexusESS <algm-SaveNexusESS>` to save data and nexus geometry to a single processed file.
- :ref:`LoadNGEM <algm-LoadNGEM>` added as a loader for the .edb files generated by the nGEM detector used for diagnostics. Generates an event workspace.
- :ref:`CalculatePlaczekSelfScattering <algm-CalculatePlaczekSelfScattering>` will calculate the Placzek correction from an incident spectrum as generated by :ref:`FitIncidentSpectrum <algm-FitIncidentSpectrum>`.
- :ref:`FitIncidentSpectrum <algm-FitIncidentSpectrum>` will fit a curve to an incident spectrum returning the curve and it's first derivative.
Instrument Definition Files
---------------------------
* A definition file for the NEAT instrument at HZB as been added along with an entry in the facilities file.
- A definition file for the NEAT instrument at HZB as been added along with an entry in the facilities file.
Data Objects
------------
* New methods :py:obj:`mantid.api.SpectrumInfo.azimuthal` and :py:obj:`mantid.geometry.DetectorInfo.azimuthal` which returns the out-of-plane angle for a spectrum
- New methods :py:obj:`mantid.api.SpectrumInfo.azimuthal` and :py:obj:`mantid.geometry.DetectorInfo.azimuthal` which returns the out-of-plane angle for a spectrum
Improvements
############
Algorithms
----------
- Whitespace is now ignored anywhere in the string when setting the Filename parameter in :ref:`Load <algm-Load>`.
- Added options to :ref:`SaveMD <algm-SaveMD>` to allow selection of what will be saved. For MDHistoWorkspace only.
- :ref:`SetGoniometer <algm-SetGoniometer>` will now work on all workspaces not just Workspace2D.
- Version upgrade :ref:`LoadNexusProcessed <algm-LoadNexusProcessed>` to allow loading of both existing Mantid format Processed Nexus files and those produced via :ref:`SaveNexusESS <algm-SaveNexusESS>`.
- A new Poisson cost function has been added to :ref:`CalculateCostFunction <algm-CalculateCostFunction>`.
- In :ref:`SaveAscii <algm-SaveAscii>` it is now possible to save out also the values of the spectrum axis.
- :ref:`IndexPeaks <algm-IndexPeaks>` now has options to enter modulation vectors and additional information required for satellite peak indexing. As
a result :ref:`IndexPeaksWithSatellites <algm-IndexPeaksWithSatellites>` has been deprecated and will be removed in a future release.
- :ref:`MaskAngle <algm-MaskAngle>` has an additional option of ``Angle='InPlane'``
Live Data
---------
* Streaming of json geometry has been added to the KafkaLiveListener. User configuration is not required for this.
- Streaming of json geometry has been added to the KafkaLiveListener. User configuration is not required for this.
The streamer automatically picks up the geometry as a part of the run information and constructs the in-memory geometry without the need for an IDF.
Python
------
* IPython widget command executor has been updated to cope with changes to IPython >= 7.1
- IPython widget command executor has been updated to cope with changes to IPython >= 7.1
API
---
It is now possible to have MultipleFileProperty configured in such a way, that it will allow empty placeholder tokens.
- :py:obj:`~mantid.api.MultipleFileProperty` can be configured to allow empty placeholder tokens.
Bug Fixes
---------
* ref:`LoadNexusMonitors <algm-LoadNexusMonitors>` bug fix for user provided top-level NXentry name.
* ref:`LoadInstrument <algm-LoadInstrument>` correctly handles IDF files which use all lowercase naming.
* Fix `LoadMD <algm-LoadMD>` handling for when parameter map is missing
#########
- :ref:`LoadNexusMonitors <algm-LoadNexusMonitors>` bug fix for user provided top-level NXentry name.
- :ref:`LoadInstrument <algm-LoadInstrument>` correctly handles IDF files which use all lowercase naming.
- Fix :ref:`LoadMD <algm-LoadMD>` handling for when parameter map is missing
