Framework#

Note

These release notes were migrated from the retired Mantid wiki (archive.mantidproject.org).

Important News#

We have been supporting two versions of the Python API since Mantid v2.0. Continuing to maintain both versions restricts further development and doubles the effort in maintaining the code.
Therefore we are phasing out v1 of the API “from mantidsimple”, in favor of it’s replacement v2 “from mantid.simpleapi”.
- This release, v2.6, will run both versions, but use of v1 of the python API will create a deprecation warning. Please do not ignore this warning as scripts that use this will NOT work in the next release of Mantid.
- Release 3.0 will only support v2 of the python API and will not run v1 scripts.
How to Update your scripts to v2
- Upload the scripts to the script repository (we have extended the deadline to the 2nd of August). The development team will then migrate all scripts in the repository, they will contact the owner for testing and verification if necessary.
- Try migrate1to2.py the automatic migration script.
- Look at the python changes notes and try to update them yourselves.
- Contact the Development Team for help.

The performance of the Load Algorithm has been speeded up, most notably for Nexus files, but with some benefit for all files.
You can now use Load to load an instrument_definition.xml file as an empty instrument.
Improved performance when loading Event Nexus files with small numbers of banks defined in the file.
Load can now load image data stored in vtk files, to bring externally processed data into the 3D visualisation tools. This algorithm can output either a MDHistogrammed workspace or, an adaptively binned MDEventWorkspace which is much more efficient for sparse data.
McStas Simulations using the monitor_nD detector can now be loaded as event workspaces using LoadMcStasEventNexus.
LoadILL can now load data from IN4,5 & 6 and D33.
LoadPSI has been added to allow data from SINQ to be loaded, although at present it only supports FOCUS.
LoadLLB has been added to allow data from LLB to be loaded, although at present it only supports Mibemol.

The interface for working with Tube Calibration has been much improved, and is ready for production use.
Extensive documentation available in this link, and examples on how to use in this link
Stored instrument details are now correctly loaded from evrnt based nexus files as well as Histogram ones if present. If the instrument definition is not found the xml definition in the instrument directory will be used.

If your data includes NaNs, infinities and points with 0 error you can now choose to ignore these in your fit by selecting the “Ignore invalid data” option in the Fit Browser.
A bug in StretchExp that affected fitting around x=0 has been fixed.
CubicSpline function has been added to the background category.

For facilities that support this (at present ADARA enadbled instruments at ORNL) you can now start a live data stream from the start of the run even when part way through.

IntegrateByComponent - Allows you to integrate the data by bank / module or door etc. by specifying how many levels above the detector you wish to integrate at.
Binary algorithms (Plus, Divide etc) - The error messages it the two workspaces are not compatible have been improved.
TOFExtinction - Extinction correction for single crystal peaks.
LoadLogPropertyTable - Will load a table of all of the values of a log across a range of files.
ExtractMaskToTable - Extracts the masking information to a table workspace.
ConvertAxisByFormula - Converts the X or Y axis of a MatrixWorkspace via a user defined math formula.
ThresholdMD - Allows a less than or greater then threshold to be applied to MDHistogram Workspaces, for the purposes of imaging.
SetSampleMaterial - Several improvements have been made.
SmoothNeighbours - Now detects if the instrument is based on rectangular detectors and adjusts the parameters appropriately.
SplineSmoothing - Smooths a MatrixWorkspace using a cubic spline.
SplineInterpolation - Interpolate one MatrixWorkspace onto another MatrixWorkspace using a cubic spline.
ModeratorTzero - Has been renamed ModeratorTzeroLinear.

RefEstimates - Was used in a REFM demo but not used in production.
EQSANSTransmission - This old method of computing the transmission has not been in use for years.
LoadNISTSANS - An old demo algorithm that was never used in production.

Please using to moving the algorithms indicated