diff --git a/docs/source/release/index.rst b/docs/source/release/index.rst index 147f387c6728de421d78a790811ac06b88252167..3e69c182fb07b9f9d4a38ab174ccb364334567e2 100644 --- a/docs/source/release/index.rst +++ b/docs/source/release/index.rst @@ -6,6 +6,7 @@ Release Notes :maxdepth: 1 :titlesonly: + v3.12.0 <v3.12.0/index> v3.11.0 <v3.11.0/index> v3.10.1 <v3.10.1/index> v3.10.0 <v3.10.0/index> diff --git a/docs/source/release/v3.12.0/diffraction.rst b/docs/source/release/v3.12.0/diffraction.rst new file mode 100644 index 0000000000000000000000000000000000000000..eef6b6039dd6c88f9d51b60127390c45cb451fe8 --- /dev/null +++ b/docs/source/release/v3.12.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 3.12.0 <v3.12.0>` \ No newline at end of file diff --git a/docs/source/release/v3.12.0/framework.rst b/docs/source/release/v3.12.0/framework.rst new file mode 100644 index 0000000000000000000000000000000000000000..eafb3687f7d0b2df3d7c12e01c26ea9ad3e1dc88 --- /dev/null +++ b/docs/source/release/v3.12.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 3.12.0 <v3.12.0>` \ No newline at end of file diff --git a/docs/source/release/v3.12.0/index.rst b/docs/source/release/v3.12.0/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..fd06369847b0bbb756438fe0cf52ffcc0e59bb8d --- /dev/null +++ b/docs/source/release/v3.12.0/index.rst @@ -0,0 +1,73 @@ +.. _v3.12.0: + +=========================== +Mantid 3.12.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 3.12.0 of Mantid. This release +celebrates 10 years of the Mantid project supporting Neutron and Muon +research. + +**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: **TODO update with current version doi** + +- *Mantid 3.12.0: Manipulation and Analysis Toolkit for Instrument Data.; Mantid Project*. `doi: 10.5286/SOFTWARE/MANTID3.12.0 <http://dx.doi.org/10.5286/SOFTWARE/MANTID3.12.0>`_ + +- 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>`_ + + +Changes +------- + +.. toctree:: + :titlesonly: + + Framework <framework> + User Interface & Usability <ui> + Diffraction <diffraction> + LowQ <lowq> + Muon Analysis <muon> + Spectroscopy <spectroscopy> + +Full Change Listings +-------------------- + +For a full list of all issues addressed during this release please see the `GitHub milestone`_. + +.. _download page: http://download.mantidproject.org + +.. _forum: http://forum.mantidproject.org + +.. _GitHub milestone: http://github.com/mantidproject/mantid/pulls?utf8=%E2%9C%93&q=is%3Apr+milestone%3A"Release+3.12"+is%3Amerged + +.. _GitHub release page: https://github.com/mantidproject/mantid/releases/tag/v3.12.0 diff --git a/docs/source/release/v3.12.0/lowq.rst b/docs/source/release/v3.12.0/lowq.rst new file mode 100644 index 0000000000000000000000000000000000000000..11d34cd71fa60c8dac64161faa2bb7f774dcc474 --- /dev/null +++ b/docs/source/release/v3.12.0/lowq.rst @@ -0,0 +1,18 @@ +============= +Low-Q 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. + +Reflectometry +------------- + +Small Angle Scattering +---------------------- + +:ref:`Release 3.12.0 <v3.12.0>` \ No newline at end of file diff --git a/docs/source/release/v3.12.0/muon.rst b/docs/source/release/v3.12.0/muon.rst new file mode 100644 index 0000000000000000000000000000000000000000..4f2ddd437c7e04ca437d90b34f94f3595863bbcf --- /dev/null +++ b/docs/source/release/v3.12.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 3.12.0 <v3.12.0>` \ No newline at end of file diff --git a/docs/source/release/v3.12.0/spectroscopy.rst b/docs/source/release/v3.12.0/spectroscopy.rst new file mode 100644 index 0000000000000000000000000000000000000000..bf7f6d55d0654e5150a36e3b014c8ad81f78ba74 --- /dev/null +++ b/docs/source/release/v3.12.0/spectroscopy.rst @@ -0,0 +1,18 @@ +==================== +Spectroscopy 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. + +Direct Geometry +--------------- + +Indirect Geometry +----------------- + +:ref:`Release 3.12.0 <v3.12.0>` \ No newline at end of file diff --git a/docs/source/release/v3.12.0/ui.rst b/docs/source/release/v3.12.0/ui.rst new file mode 100644 index 0000000000000000000000000000000000000000..48c549acd4c372a30ad8b4b49e787a2d97935b76 --- /dev/null +++ b/docs/source/release/v3.12.0/ui.rst @@ -0,0 +1,21 @@ +====================== +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 +------------ + +Workbench +--------- + +SliceViewer and Vates Simple Interface +-------------------------------------- + +:ref:`Release 3.12.0 <v3.12.0>` \ No newline at end of file