From b74c222948c273e5dc0573fb455feb3d53849a03 Mon Sep 17 00:00:00 2001 From: Caila Finn Date: Wed, 18 Jun 2025 13:06:24 +0100 Subject: [PATCH 1/6] Update direct geometry release notes RE #39471 --- docs/source/concepts/CrystalField.rst | 2 ++ docs/source/release/v6.13.0/direct_geometry.rst | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/source/concepts/CrystalField.rst b/docs/source/concepts/CrystalField.rst index 5b320be6546d..df782b0df474 100644 --- a/docs/source/concepts/CrystalField.rst +++ b/docs/source/concepts/CrystalField.rst @@ -432,6 +432,8 @@ where :math:`\theta_k` are the Stevens operator equivalent factors tabulated in ---- +.. _Crystal Field Tables: + Appendix B: Tables ------------------ diff --git a/docs/source/release/v6.13.0/direct_geometry.rst b/docs/source/release/v6.13.0/direct_geometry.rst index 2a6cc472705b..cf98baff879b 100644 --- a/docs/source/release/v6.13.0/direct_geometry.rst +++ b/docs/source/release/v6.13.0/direct_geometry.rst @@ -10,7 +10,8 @@ General New features ############ -- :ref:`LoadCIF ` now accepts the short forms of the Hermann-Mauguin symbols. These short forms may include a single space or none at all. +- :ref:`LoadCIF ` now accepts the short forms of the Hermann-Mauguin symbols. These short forms may + include a single space or none at all. Bugfixes ############ @@ -26,7 +27,8 @@ New features Bugfixes ############ -- Removed unnecessary fix for IB21 for C1 and Ci symmetries in the Crystal Field peak base function to match the documentation: https://docs.mantidproject.org/nightly/concepts/CrystalField.html#appendix-b-tables +- Removed unnecessary fix for ``IB21`` for ``C1`` and ``Ci`` symmetries in the Crystal Field peak base function to match + the documentation in :ref:`Crystal Field Tables`. MSlice From be8df013774b5ab7db7bd1ad5c89ab6e78d3da30 Mon Sep 17 00:00:00 2001 From: Caila Finn Date: Wed, 18 Jun 2025 13:30:05 +0100 Subject: [PATCH 2/6] Update indirect geometry documentation RE #39471 --- .../release/v6.13.0/indirect_geometry.rst | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/source/release/v6.13.0/indirect_geometry.rst b/docs/source/release/v6.13.0/indirect_geometry.rst index 13407d51de1d..46fa1ddf6abe 100644 --- a/docs/source/release/v6.13.0/indirect_geometry.rst +++ b/docs/source/release/v6.13.0/indirect_geometry.rst @@ -7,8 +7,10 @@ Indirect Geometry Changes New Features ------------ -- Algorithm :ref:`algm-VesuvioPeakPrediction` now supports option ``Classical``, used to estimate the lower bounds of the width of the Neutron Compton Profiles when running analysis routines. -- :ref:`ISIS Energy Transfer tab ` now supports an output label that is appended to the output name and doesn't override previous outputs +- :ref:`algm-VesuvioPeakPrediction` now supports a ``Classical`` option. It is used to estimate the lower bounds of the + width of the Neutron Compton Profiles when running analysis routines. +- :ref:`ISIS Energy Transfer tab ` now supports an output label that is appended to the output name + and doesn't override previous outputs Bugfixes @@ -21,13 +23,13 @@ Algorithms New features ############ -- The "Atoms" field of Abins and Abins2D algorithms has been enhanced - to support more kinds of input. Individual atoms may still be - selected with e.g. "atom1" or "atom_1", but "1" is now also a valid - input to select the first atom. In addition, ranges can be specified - as e.g. "2-4" or "2..4". This makes the user input more concise, but - will still create individual workspaces for atoms 2, 3, and 4. -- A "CacheDirectory" parameter has been added to the Abins and Abins2D algorithms. This allows an explicit cache directory to be set independently for each calculation; the previous behaviour (to use the User Save Directory) remains available as the default value. +- The ``Atoms`` field of :ref:`algm-Abins` and :ref:`algm-Abins2D` algorithms has been enhanced to support more kinds of + input. Individual atoms may still be selected with e.g. ``atom1`` or ``atom_1``, but ``1`` is now also a valid input + to select the first atom. In addition, ranges can be specified as e.g. ``2-4`` or ``2..4``. This makes the user input + more concise, but will still create individual workspaces for atoms ``2``, ``3``, and ``4``. +- A ``CacheDirectory`` parameter has been added to the :ref:`algm-Abins` and :ref:`algm-Abins2D` algorithms. This allows + an explicit cache directory to be set independently for each calculation; the previous behaviour (to use the User Save + Directory) remains available as the default value. Bugfixes ############ From 9e9cfedbb42d11b13ec3f6e0ef5120aa7d1cf8b2 Mon Sep 17 00:00:00 2001 From: Caila Finn Date: Wed, 18 Jun 2025 13:36:44 +0100 Subject: [PATCH 3/6] Edit Muon release notes RE #39471 --- docs/source/release/v6.13.0/muon.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/release/v6.13.0/muon.rst b/docs/source/release/v6.13.0/muon.rst index 7c6215e52c0d..3aa161c08b0c 100644 --- a/docs/source/release/v6.13.0/muon.rst +++ b/docs/source/release/v6.13.0/muon.rst @@ -19,8 +19,10 @@ Muon Analysis Bugfixes ############ -- Fix a crash ocurring in the :ref:`Results Tab ` of the :ref:`Muon Analysis ` interface when an integer time series was added as a log in the results table. -- Allow the `current_period` sample log from the selected fitted workspace to be added to the :ref:`results table `. +- Fix a crash occurring in the :ref:`Results Tab ` of the :ref:`Muon Analysis ` + interface when an integer time series was added as a log in the results table. +- Allow the ``current_period`` sample log from the selected fitted workspace to be added to the + :ref:`results table `. Muon Analysis and Frequency Domain Analysis From 11bdb33758bd038137bf859db6e58a094ad40b6c Mon Sep 17 00:00:00 2001 From: Caila Finn Date: Wed, 18 Jun 2025 13:49:00 +0100 Subject: [PATCH 4/6] Add inelastic release notes RE #39471 --- docs/source/release/v6.13.0/inelastic.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/source/release/v6.13.0/inelastic.rst b/docs/source/release/v6.13.0/inelastic.rst index 5f2e5f0c7639..02078e5c0bc9 100644 --- a/docs/source/release/v6.13.0/inelastic.rst +++ b/docs/source/release/v6.13.0/inelastic.rst @@ -7,13 +7,17 @@ Inelastic Changes New Features ------------ -- Added new `TeixeiraWaterIqtFT` fitting function, which is the Fourier Transform of `TeixeiraWaterIqt` function. This is now available in the ConvFit tab of the :ref:`QENS Fitting ` interface. +- Added a new ``TeixeiraWaterIqtFT`` fitting function, which is the Fourier Transform of the ``TeixeiraWaterIqt`` + function. This is now available in the ``ConvFit`` tab of the :ref:`QENS Fitting ` + interface. Bugfixes -------- -- :ref:`QENSFitting ` interface will generate a group workspace after fitting with suffix `_Result` when the output fit is a single fit, and suffix `_Results` when is a multiple fit. -- Clicking plot button after a fit from :ref:`QENSFitting ` no longer plot results twice. +- The :ref:`QENSFitting ` interface will now generate a group workspace after fitting + with suffix ``_Result`` when the output fit is a single fit, and suffix ``_Results`` when is a multiple fit. +- Clicking the plot button after a fit from :ref:`QENSFitting ` no longer plots the + results twice. Algorithms @@ -21,7 +25,8 @@ Algorithms New features ############ -- :ref:`BayesQuasi2 ` and :ref:`BayesStretch2 ` are now available for all Mantid users now that ``quickbayes`` v1.0.2 is installed as a ``mantid`` dependency via Conda. +- :ref:`BayesQuasi2 ` and :ref:`BayesStretch2 ` are now available for all Mantid + users now that ``quickbayes`` v1.0.2 is installed as a ``mantid`` dependency via Conda. Bugfixes ############ From 1cc02a8b8f35e0161085530b8885ed520161f09a Mon Sep 17 00:00:00 2001 From: Caila Finn Date: Fri, 20 Jun 2025 10:50:27 +0100 Subject: [PATCH 5/6] Add missing full stop RE #39471 --- docs/source/release/v6.13.0/indirect_geometry.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/release/v6.13.0/indirect_geometry.rst b/docs/source/release/v6.13.0/indirect_geometry.rst index 46fa1ddf6abe..c1fe2b0a1343 100644 --- a/docs/source/release/v6.13.0/indirect_geometry.rst +++ b/docs/source/release/v6.13.0/indirect_geometry.rst @@ -10,7 +10,7 @@ New Features - :ref:`algm-VesuvioPeakPrediction` now supports a ``Classical`` option. It is used to estimate the lower bounds of the width of the Neutron Compton Profiles when running analysis routines. - :ref:`ISIS Energy Transfer tab ` now supports an output label that is appended to the output name - and doesn't override previous outputs + and doesn't override previous outputs. Bugfixes From 8c980767939638a407b592c94c572c1eeba89f54 Mon Sep 17 00:00:00 2001 From: Caila Finn Date: Fri, 20 Jun 2025 10:50:47 +0100 Subject: [PATCH 6/6] Fix capitalisation RE #39471 --- docs/source/release/v6.13.0/inelastic.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/release/v6.13.0/inelastic.rst b/docs/source/release/v6.13.0/inelastic.rst index 02078e5c0bc9..93b4ed2bab89 100644 --- a/docs/source/release/v6.13.0/inelastic.rst +++ b/docs/source/release/v6.13.0/inelastic.rst @@ -26,7 +26,7 @@ Algorithms New features ############ - :ref:`BayesQuasi2 ` and :ref:`BayesStretch2 ` are now available for all Mantid - users now that ``quickbayes`` v1.0.2 is installed as a ``mantid`` dependency via Conda. + users now that ``quickbayes`` v1.0.2 is installed as a ``mantid`` dependency via conda. Bugfixes ############