diff --git a/docs/source/release/index.rst b/docs/source/release/index.rst index d59ca3b1cc7d1d186b907754ef3f1c0b5561af0f..f4227b61684058e819909c3322e0c0fbba22b520 100644 --- a/docs/source/release/index.rst +++ b/docs/source/release/index.rst @@ -11,6 +11,7 @@ Release Notes */index +* :doc:`v5.1.0 <v5.1.0/index>` * :doc:`v5.0.0 <v5.0.0/index>` * :doc:`v4.2.0 <v4.2.0/index>` * :doc:`v4.1.0 <v4.1.0/index>` diff --git a/docs/source/release/v5.1.0/diffraction.rst b/docs/source/release/v5.1.0/diffraction.rst new file mode 100644 index 0000000000000000000000000000000000000000..d4c0041287b2310f43156cddeda2fe8b045647e2 --- /dev/null +++ b/docs/source/release/v5.1.0/diffraction.rst @@ -0,0 +1,24 @@ +=================== +Diffraction 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. + +Powder Diffraction +------------------ + +Engineering Diffraction +----------------------- + +Single Crystal Diffraction +-------------------------- + +Imaging +------- + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/direct_geometry.rst b/docs/source/release/v5.1.0/direct_geometry.rst new file mode 100644 index 0000000000000000000000000000000000000000..628b6b12b08c811fccdc7967e2a9b14e151382dd --- /dev/null +++ b/docs/source/release/v5.1.0/direct_geometry.rst @@ -0,0 +1,12 @@ +======================= +Direct 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. + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/framework.rst b/docs/source/release/v5.1.0/framework.rst new file mode 100644 index 0000000000000000000000000000000000000000..ae2e09328dc32820d41b44a451b196a6d395c685 --- /dev/null +++ b/docs/source/release/v5.1.0/framework.rst @@ -0,0 +1,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. + +Concepts +-------- + +Algorithms +---------- + +Data Objects +------------ + +Python +------ + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/index.rst b/docs/source/release/v5.1.0/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..ec24f28adfa070b06c7181b84cb9ba3912c204b4 --- /dev/null +++ b/docs/source/release/v5.1.0/index.rst @@ -0,0 +1,89 @@ +.. _v5.1.0: + +=========================== +Mantid 5.1.0 Release Notes +=========================== + +.. figure:: ../../images/ImageNotFound.png + :class: screenshot + :width: 385px + :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 5.1.0 of Mantid. + +**TODO: Add paragraph summarizing big changes** + +This is just one of 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. + +Throughout the Mantid project we put a lot of effort into ensuring +Mantid is a robust and reliable product. Thank you to everyone that has +reported any issues to us. Please keep on reporting any problems you +have, or crashes that occur on our `forum`_. + +Installation packages can be found on our `download page`_ +which now links to sourceforge to mirror our download files around the world, you can also +access the source code on `GitHub release page`_. + +Citation +-------- + +Please cite any usage of Mantid as follows: + +- *Mantid 5.1.0: Manipulation and Analysis Toolkit for Instrument Data.; Mantid Project*. `doi: 10.5286/SOFTWARE/MANTID5.1 <https://dx.doi.org/10.5286/SOFTWARE/MANTID5.1>`_ + +- Arnold, O. et al. *Mantid-Data Analysis and Visualization Package for Neutron Scattering and mu-SR Experiments.* Nuclear Instruments + and Methods in Physics Research Section A: Accelerators, Spectrometers, Detectors and Associated Equipment 764 (2014): 156-166 + `doi: 10.1016/j.nima.2014.07.029 <https://doi.org/10.1016/j.nima.2014.07.029>`_ + (`download bibtex <https://raw.githubusercontent.com/mantidproject/mantid/master/docs/source/mantid.bib>`_) + + +Changes +------- + +.. toctree:: + :hidden: + :glob: + + * + +- :doc:`Framework <framework>` +- :doc:`General UI & Usability <ui>` + + - :doc:`MantidPlot <mantidplot>` + + - :doc:`MantidWorkbench <mantidworkbench>` +- :doc:`Diffraction <diffraction>` +- :doc:`Muon Analysis <muon>` +- Low Q + + - :doc:`Reflectometry <reflectometry>` + + - :doc:`SANS <sans>` +- Spectroscopy + + - :doc:`Direct Geometry <direct_geometry>` + + - :doc:`Indirect Geometry <indirect_geometry>` + +Full Change Listings +-------------------- + +For a full list of all issues addressed during this release please see the `GitHub milestone`_. + +.. _download page: https://download.mantidproject.org + +.. _forum: https://forum.mantidproject.org + +.. _GitHub milestone: https://github.com/mantidproject/mantid/pulls?utf8=%E2%9C%93&q=is%3Apr+milestone%3A"Release Release 5.1"+is%3Amerged + +.. _GitHub release page: https://github.com/mantidproject/mantid/releases/tag/v5.1.0 diff --git a/docs/source/release/v5.1.0/indirect_geometry.rst b/docs/source/release/v5.1.0/indirect_geometry.rst new file mode 100644 index 0000000000000000000000000000000000000000..84690c899f4471820ccbe59a877cacb4e3eb6361 --- /dev/null +++ b/docs/source/release/v5.1.0/indirect_geometry.rst @@ -0,0 +1,12 @@ +========================= +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. + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/mantidplot.rst b/docs/source/release/v5.1.0/mantidplot.rst new file mode 100644 index 0000000000000000000000000000000000000000..1180e95e2ccb2c46f5dfce2cc1662e7e519ccb3b --- /dev/null +++ b/docs/source/release/v5.1.0/mantidplot.rst @@ -0,0 +1,14 @@ +================== +MantidPlot Changes +================== + +.. contents:: Table of Contents + :local: + +Improvements +############ + +Bugfixes +######## + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/mantidworkbench.rst b/docs/source/release/v5.1.0/mantidworkbench.rst new file mode 100644 index 0000000000000000000000000000000000000000..8a82337394021d6ee1ddeafd70fd5631239f029e --- /dev/null +++ b/docs/source/release/v5.1.0/mantidworkbench.rst @@ -0,0 +1,14 @@ +======================= +MantidWorkbench Changes +======================= + +.. contents:: Table of Contents + :local: + +Improvements +############ + +Bugfixes +######## + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/muon.rst b/docs/source/release/v5.1.0/muon.rst new file mode 100644 index 0000000000000000000000000000000000000000..779986afebafe3d0d78897e2f00b6ffebf28ccf0 --- /dev/null +++ b/docs/source/release/v5.1.0/muon.rst @@ -0,0 +1,13 @@ +============ +MuSR 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. + + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/reflectometry.rst b/docs/source/release/v5.1.0/reflectometry.rst new file mode 100644 index 0000000000000000000000000000000000000000..23087ab418c0c4686d69bbca5ac02dcbe761f41e --- /dev/null +++ b/docs/source/release/v5.1.0/reflectometry.rst @@ -0,0 +1,12 @@ +===================== +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. + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/sans.rst b/docs/source/release/v5.1.0/sans.rst new file mode 100644 index 0000000000000000000000000000000000000000..55987fa73f23a3f824c856999183185f19572fbc --- /dev/null +++ b/docs/source/release/v5.1.0/sans.rst @@ -0,0 +1,12 @@ +============ +SANS 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. + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file diff --git a/docs/source/release/v5.1.0/ui.rst b/docs/source/release/v5.1.0/ui.rst new file mode 100644 index 0000000000000000000000000000000000000000..f54c0b9bf1b1fcfc515e9208e63ff8a7b360b5a6 --- /dev/null +++ b/docs/source/release/v5.1.0/ui.rst @@ -0,0 +1,28 @@ +====================== +UI & Usability 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. + +Installation +------------ + +MantidPlot +---------- + +See :doc:`mantidplot`. + +MantidWorkbench +--------------- + +See :doc:`mantidworkbench`. + +SliceViewer and Vates Simple Interface +-------------------------------------- + +:ref:`Release 5.1.0 <v5.1.0>` \ No newline at end of file