Skip to content

Commit

Permalink
Merge pull request #38612 from mantidproject/update_release_notes
Browse files Browse the repository at this point in the history
6.13 release notes
  • Loading branch information
thomashampson authored Jan 16, 2025
2 parents 39fb5ab + 16f1fb9 commit 2d44e11
Show file tree
Hide file tree
Showing 61 changed files with 449 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/release/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Release Notes

*/index

* :doc:`v6.13.0 <v6.13.0/index>`
* :doc:`v6.12.0 <v6.12.0/index>`
* :doc:`v6.11.0 <v6.11.0/index>`
* :doc:`v6.10.0 <v6.10.0/index>`
Expand Down
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
43 changes: 43 additions & 0 deletions docs/source/release/v6.13.0/diffraction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
===================
Diffraction Changes
===================

.. contents:: Table of Contents
:local:

Powder Diffraction
------------------

New features
############
.. amalgamate:: Diffraction/Powder/New_features

Bugfixes
############
.. amalgamate:: Diffraction/Powder/Bugfixes


Engineering Diffraction
-----------------------

New features
############
.. amalgamate:: Diffraction/Engineering/New_features

Bugfixes
############
.. amalgamate:: Diffraction/Engineering/Bugfixes


Single Crystal Diffraction
--------------------------

New features
############
.. amalgamate:: Diffraction/Single_Crystal/New_features

Bugfixes
############
.. amalgamate:: Diffraction/Single_Crystal/Bugfixes

:ref:`Release 6.13.0 <v6.13.0>`
43 changes: 43 additions & 0 deletions docs/source/release/v6.13.0/direct_geometry.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
=======================
Direct Geometry Changes
=======================

.. contents:: Table of Contents
:local:

General
-------

New features
############
.. amalgamate:: Direct_Geometry/General/New_features

Bugfixes
############
.. amalgamate:: Direct_Geometry/General/Bugfixes


CrystalField
-------------

New features
############
.. amalgamate:: Direct_Geometry/CrystalField/New_features

Bugfixes
############
.. amalgamate:: Direct_Geometry/CrystalField/Bugfixes


MSlice
------

New features
############
.. amalgamate:: Direct_Geometry/MSlice/New_features

Bugfixes
############
.. amalgamate:: Direct_Geometry/MSlice/Bugfixes

:ref:`Release 6.13.0 <v6.13.0>`
88 changes: 88 additions & 0 deletions docs/source/release/v6.13.0/framework.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
=================
Framework Changes
=================

.. contents:: Table of Contents
:local:

Algorithms
----------

New features
############
.. amalgamate:: Framework/Algorithms/New_features

Bugfixes
############
.. amalgamate:: Framework/Algorithms/Bugfixes

Deprecated
############
.. amalgamate:: Framework/Algorithms/Deprecated

Removed
############
.. amalgamate:: Framework/Algorithms/Removed

Fit Functions
-------------

New features
############
.. amalgamate:: Framework/Fit_Functions/New_features

Bugfixes
############
.. amalgamate:: Framework/Fit_Functions/Bugfixes

Deprecated
############
.. amalgamate:: Framework/Fit_Functions/Deprecated

Removed
############
.. amalgamate:: Framework/Fit_Functions/Removed


Data Objects
------------

New features
############
.. amalgamate:: Framework/Data_Objects/New_features

Bugfixes
############
.. amalgamate:: Framework/Data_Objects/Bugfixes


Python
------

New features
############
.. amalgamate:: Framework/Python/New_features

Bugfixes
############
.. amalgamate:: Framework/Python/Bugfixes


Dependencies
------------------

New features
############
.. amalgamate:: Framework/Dependencies/New_features

Bugfixes
############
.. amalgamate:: Framework/Dependencies/Bugfixes


MantidWorkbench
---------------

See :doc:`mantidworkbench`.

:ref:`Release 6.13.0 <v6.13.0>`
87 changes: 87 additions & 0 deletions docs/source/release/v6.13.0/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
.. _v6.13.0:

===========================
Mantid 6.13.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 6.13.0 of Mantid.

**TODO: Add paragraph summarizing big changes**

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.

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 the assets on our `GitHub release page`_, where you can also
access the source code for the release.

Citation
--------

Please cite any usage of Mantid as follows:

- *Mantid 6.13.0: Manipulation and Analysis Toolkit for Instrument Data.; Mantid Project*. `doi: 10.5286/SOFTWARE/MANTID6.13 <https://dx.doi.org/10.5286/SOFTWARE/MANTID6.13>`_

- 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:`Mantid Workbench <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>`

- :doc:`Inelastic <inelastic>`

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%22Release+6.13%22+is%3Amerged

.. _GitHub release page: https://github.com/mantidproject/mantid/releases/tag/v6.13.0
29 changes: 29 additions & 0 deletions docs/source/release/v6.13.0/indirect_geometry.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
=========================
Indirect Geometry Changes
=========================

.. contents:: Table of Contents
:local:

New Features
------------
.. amalgamate:: Indirect/New_features


Bugfixes
--------
.. amalgamate:: Indirect/Bugfixes


Algorithms
----------

New features
############
.. amalgamate:: Indirect/Algorithms/New_features

Bugfixes
############
.. amalgamate:: Indirect/Algorithms/Bugfixes

:ref:`Release 6.13.0 <v6.13.0>`
29 changes: 29 additions & 0 deletions docs/source/release/v6.13.0/inelastic.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
=================
Inelastic Changes
=================

.. contents:: Table of Contents
:local:

New Features
------------
.. amalgamate:: Inelastic/New_features


Bugfixes
--------
.. amalgamate:: Inelastic/Bugfixes


Algorithms
----------

New features
############
.. amalgamate:: Inelastic/Algorithms/New_features

Bugfixes
############
.. amalgamate:: Inelastic/Algorithms/Bugfixes

:ref:`Release 6.13.0 <v6.13.0>`
41 changes: 41 additions & 0 deletions docs/source/release/v6.13.0/mantidworkbench.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
========================
Mantid Workbench Changes
========================

.. contents:: Table of Contents
:local:

New Features
------------
.. amalgamate:: Workbench/New_features


Bugfixes
--------
.. amalgamate:: Workbench/Bugfixes


InstrumentViewer
----------------

New features
############
.. amalgamate:: Workbench/InstrumentViewer/New_features

Bugfixes
############
.. amalgamate:: Workbench/InstrumentViewer/Bugfixes


SliceViewer
-----------

New features
############
.. amalgamate:: Workbench/SliceViewer/New_features

Bugfixes
############
.. amalgamate:: Workbench/SliceViewer/Bugfixes

:ref:`Release 6.13.0 <v6.13.0>`
Loading

0 comments on commit 2d44e11

Please sign in to comment.