diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38667.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38667.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38667.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38667.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38668.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38668.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38668.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38668.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38863.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38863.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38863.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38863.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38882.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38882.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/38882.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/38882.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/39084.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/39084.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/39084.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/39084.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/39104.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/39104.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/39104.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/39104.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/39148.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/39148.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/39148.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/Bugfixes/Used/39148.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/38440.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/38440.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/New_features/38440.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/38440.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/38863.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/38863.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/New_features/38863.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/38863.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/39139.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/39139.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/New_features/39139.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/39139.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/39197.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/39197.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/New_features/39197.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/39197.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/39206.rst b/docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/39206.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Engineering/New_features/39206.rst rename to docs/source/release/v6.13.0/Diffraction/Engineering/New_features/Used/39206.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/39101.rst b/docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/Used/39101.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/39101.rst rename to docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/Used/39101.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/39112.rst b/docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/Used/39112.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/39112.rst rename to docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/Used/39112.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/39203.rst b/docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/Used/39203.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/39203.rst rename to docs/source/release/v6.13.0/Diffraction/Powder/Bugfixes/Used/39203.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Powder/New_features/38279.rst b/docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/38279.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Powder/New_features/38279.rst rename to docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/38279.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Powder/New_features/38887.rst b/docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/38887.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Powder/New_features/38887.rst rename to docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/38887.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Powder/New_features/38968.rst b/docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/38968.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Powder/New_features/38968.rst rename to docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/38968.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Powder/New_features/39101.rst b/docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/39101.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Powder/New_features/39101.rst rename to docs/source/release/v6.13.0/Diffraction/Powder/New_features/Used/39101.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Single_Crystal/Bugfixes/39163.rst b/docs/source/release/v6.13.0/Diffraction/Single_Crystal/Bugfixes/Used/39163.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Single_Crystal/Bugfixes/39163.rst rename to docs/source/release/v6.13.0/Diffraction/Single_Crystal/Bugfixes/Used/39163.rst diff --git a/docs/source/release/v6.13.0/Diffraction/Single_Crystal/New_features/38969.rst b/docs/source/release/v6.13.0/Diffraction/Single_Crystal/New_features/Used/38969.rst similarity index 100% rename from docs/source/release/v6.13.0/Diffraction/Single_Crystal/New_features/38969.rst rename to docs/source/release/v6.13.0/Diffraction/Single_Crystal/New_features/Used/38969.rst diff --git a/docs/source/release/v6.13.0/Direct_Geometry/CrystalField/Bugfixes/39039.rst b/docs/source/release/v6.13.0/Direct_Geometry/CrystalField/Bugfixes/Used/39039.rst similarity index 100% rename from docs/source/release/v6.13.0/Direct_Geometry/CrystalField/Bugfixes/39039.rst rename to docs/source/release/v6.13.0/Direct_Geometry/CrystalField/Bugfixes/Used/39039.rst diff --git a/docs/source/release/v6.13.0/Direct_Geometry/General/New_features/39116.rst b/docs/source/release/v6.13.0/Direct_Geometry/General/New_features/Used/39116.rst similarity index 100% rename from docs/source/release/v6.13.0/Direct_Geometry/General/New_features/39116.rst rename to docs/source/release/v6.13.0/Direct_Geometry/General/New_features/Used/39116.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/36989.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/36989.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/36989.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/36989.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/37375.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/37375.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/37375.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/37375.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/38143.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/38143.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/38143.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/38143.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39041.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39041.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39041.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39041.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39094.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39094.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39094.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39094.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39107.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39107.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39107.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39107.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39125.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39125.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39125.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39125.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39205.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39205.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39205.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39205.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39241.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39241.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39241.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39241.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39246.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39246.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39246.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39246.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39304.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39304.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39304.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/Used/39304.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/37799.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/37799.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/37799.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/37799.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39097.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39097.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39097.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39097.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39132.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39132.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39132.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39132.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39218.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39218.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39218.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39218.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39276.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39276.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39276.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39276.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39282.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39282.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39282.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39282.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39297.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39297.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39297.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/Used/39297.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/38512.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/38512.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/38512.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/38512.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/38815.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/38815.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/38815.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/38815.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/38960.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/38960.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/38960.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/38960.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39032.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39032.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39032.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39032.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39041.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39041.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39041.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39041.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39157.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39157.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39157.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39157.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39181.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39181.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39181.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39181.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39208.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39208.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39208.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39208.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39210.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39210.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39210.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39210.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39219.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39219.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39219.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39219.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39289.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39289.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39289.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39289.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/New_features/39324.rst b/docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39324.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/New_features/39324.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/New_features/Used/39324.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/38793.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/38793.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/38793.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/38793.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/38794.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/38794.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/38794.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/38794.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/39017.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39017.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/39017.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39017.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/39022.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39022.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/39022.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39022.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/39033.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39033.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/39033.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39033.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/39053.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39053.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/39053.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39053.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/39168.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39168.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/39168.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39168.rst diff --git a/docs/source/release/v6.13.0/Framework/Algorithms/Removed/39195.rst b/docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39195.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Algorithms/Removed/39195.rst rename to docs/source/release/v6.13.0/Framework/Algorithms/Removed/Used/39195.rst diff --git a/docs/source/release/v6.13.0/Framework/Bugfixes/39020.rst b/docs/source/release/v6.13.0/Framework/Bugfixes/Used/39020.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Bugfixes/39020.rst rename to docs/source/release/v6.13.0/Framework/Bugfixes/Used/39020.rst diff --git a/docs/source/release/v6.13.0/Framework/Bugfixes/39126.rst b/docs/source/release/v6.13.0/Framework/Bugfixes/Used/39126.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Bugfixes/39126.rst rename to docs/source/release/v6.13.0/Framework/Bugfixes/Used/39126.rst diff --git a/docs/source/release/v6.13.0/Framework/Bugfixes/39238.rst b/docs/source/release/v6.13.0/Framework/Bugfixes/Used/39238.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Bugfixes/39238.rst rename to docs/source/release/v6.13.0/Framework/Bugfixes/Used/39238.rst diff --git a/docs/source/release/v6.13.0/Framework/Build_tools/Bugfixes/38943.rst b/docs/source/release/v6.13.0/Framework/Build_tools/Bugfixes/Used/38943.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Build_tools/Bugfixes/38943.rst rename to docs/source/release/v6.13.0/Framework/Build_tools/Bugfixes/Used/38943.rst diff --git a/docs/source/release/v6.13.0/Framework/Data_Handling/Deprecated/39176.rst b/docs/source/release/v6.13.0/Framework/Data_Handling/Deprecated/Used/39176.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Data_Handling/Deprecated/39176.rst rename to docs/source/release/v6.13.0/Framework/Data_Handling/Deprecated/Used/39176.rst diff --git a/docs/source/release/v6.13.0/Framework/Data_Handling/New_features/39243.rst b/docs/source/release/v6.13.0/Framework/Data_Handling/New_features/Used/39243.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Data_Handling/New_features/39243.rst rename to docs/source/release/v6.13.0/Framework/Data_Handling/New_features/Used/39243.rst diff --git a/docs/source/release/v6.13.0/Framework/Data_Handling/Removed/38760.rst b/docs/source/release/v6.13.0/Framework/Data_Handling/Removed/Used/38760.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Data_Handling/Removed/38760.rst rename to docs/source/release/v6.13.0/Framework/Data_Handling/Removed/Used/38760.rst diff --git a/docs/source/release/v6.13.0/Framework/Dependencies/New_features/37780.rst b/docs/source/release/v6.13.0/Framework/Dependencies/New_features/Used/37780.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Dependencies/New_features/37780.rst rename to docs/source/release/v6.13.0/Framework/Dependencies/New_features/Used/37780.rst diff --git a/docs/source/release/v6.13.0/Framework/Diffraction/Engineering/New_features/38806.rst b/docs/source/release/v6.13.0/Framework/Diffraction/Engineering/New_features/Used/38806.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Diffraction/Engineering/New_features/38806.rst rename to docs/source/release/v6.13.0/Framework/Diffraction/Engineering/New_features/Used/38806.rst diff --git a/docs/source/release/v6.13.0/Framework/New_features/38803.rst b/docs/source/release/v6.13.0/Framework/New_features/Used/38803.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/New_features/38803.rst rename to docs/source/release/v6.13.0/Framework/New_features/Used/38803.rst diff --git a/docs/source/release/v6.13.0/Framework/New_features/39133.rst b/docs/source/release/v6.13.0/Framework/New_features/Used/39133.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/New_features/39133.rst rename to docs/source/release/v6.13.0/Framework/New_features/Used/39133.rst diff --git a/docs/source/release/v6.13.0/Framework/Python/Bugfixes/38821.rst b/docs/source/release/v6.13.0/Framework/Python/Bugfixes/Used/38821.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Python/Bugfixes/38821.rst rename to docs/source/release/v6.13.0/Framework/Python/Bugfixes/Used/38821.rst diff --git a/docs/source/release/v6.13.0/Framework/Python/Bugfixes/38886.rst b/docs/source/release/v6.13.0/Framework/Python/Bugfixes/Used/38886.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Python/Bugfixes/38886.rst rename to docs/source/release/v6.13.0/Framework/Python/Bugfixes/Used/38886.rst diff --git a/docs/source/release/v6.13.0/Framework/Python/New_features/37248.rst b/docs/source/release/v6.13.0/Framework/Python/New_features/Used/37248.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Python/New_features/37248.rst rename to docs/source/release/v6.13.0/Framework/Python/New_features/Used/37248.rst diff --git a/docs/source/release/v6.13.0/Framework/Python/New_features/38736.rst b/docs/source/release/v6.13.0/Framework/Python/New_features/Used/38736.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Python/New_features/38736.rst rename to docs/source/release/v6.13.0/Framework/Python/New_features/Used/38736.rst diff --git a/docs/source/release/v6.13.0/Framework/Python/New_features/39044.rst b/docs/source/release/v6.13.0/Framework/Python/New_features/Used/39044.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Python/New_features/39044.rst rename to docs/source/release/v6.13.0/Framework/Python/New_features/Used/39044.rst diff --git a/docs/source/release/v6.13.0/Framework/Python/New_features/39144.rst b/docs/source/release/v6.13.0/Framework/Python/New_features/Used/39144.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Python/New_features/39144.rst rename to docs/source/release/v6.13.0/Framework/Python/New_features/Used/39144.rst diff --git a/docs/source/release/v6.13.0/Framework/Python/New_features/39277.rst b/docs/source/release/v6.13.0/Framework/Python/New_features/Used/39277.rst similarity index 100% rename from docs/source/release/v6.13.0/Framework/Python/New_features/39277.rst rename to docs/source/release/v6.13.0/Framework/Python/New_features/Used/39277.rst diff --git a/docs/source/release/v6.13.0/Indirect/Algorithms/New_features/38620.rst b/docs/source/release/v6.13.0/Indirect/Algorithms/New_features/Used/38620.rst similarity index 100% rename from docs/source/release/v6.13.0/Indirect/Algorithms/New_features/38620.rst rename to docs/source/release/v6.13.0/Indirect/Algorithms/New_features/Used/38620.rst diff --git a/docs/source/release/v6.13.0/Indirect/Algorithms/New_features/39170.rst b/docs/source/release/v6.13.0/Indirect/Algorithms/New_features/Used/39170.rst similarity index 100% rename from docs/source/release/v6.13.0/Indirect/Algorithms/New_features/39170.rst rename to docs/source/release/v6.13.0/Indirect/Algorithms/New_features/Used/39170.rst diff --git a/docs/source/release/v6.13.0/Indirect/New_features/38607.rst b/docs/source/release/v6.13.0/Indirect/New_features/Used/38607.rst similarity index 100% rename from docs/source/release/v6.13.0/Indirect/New_features/38607.rst rename to docs/source/release/v6.13.0/Indirect/New_features/Used/38607.rst diff --git a/docs/source/release/v6.13.0/Indirect/New_features/39212.rst b/docs/source/release/v6.13.0/Indirect/New_features/Used/39212.rst similarity index 100% rename from docs/source/release/v6.13.0/Indirect/New_features/39212.rst rename to docs/source/release/v6.13.0/Indirect/New_features/Used/39212.rst diff --git a/docs/source/release/v6.13.0/Inelastic/Algorithms/New_features/35918.rst b/docs/source/release/v6.13.0/Inelastic/Algorithms/New_features/Used/35918.rst similarity index 100% rename from docs/source/release/v6.13.0/Inelastic/Algorithms/New_features/35918.rst rename to docs/source/release/v6.13.0/Inelastic/Algorithms/New_features/Used/35918.rst diff --git a/docs/source/release/v6.13.0/Inelastic/Bugfixes/38827.rst b/docs/source/release/v6.13.0/Inelastic/Bugfixes/Used/38827.rst similarity index 100% rename from docs/source/release/v6.13.0/Inelastic/Bugfixes/38827.rst rename to docs/source/release/v6.13.0/Inelastic/Bugfixes/Used/38827.rst diff --git a/docs/source/release/v6.13.0/Inelastic/New_features/37237.rst b/docs/source/release/v6.13.0/Inelastic/New_features/Used/37237.rst similarity index 100% rename from docs/source/release/v6.13.0/Inelastic/New_features/37237.rst rename to docs/source/release/v6.13.0/Inelastic/New_features/Used/37237.rst diff --git a/docs/source/release/v6.13.0/Muon/Algorithms/Bugfixes/39178.rst b/docs/source/release/v6.13.0/Muon/Algorithms/Bugfixes/Used/39178.rst similarity index 100% rename from docs/source/release/v6.13.0/Muon/Algorithms/Bugfixes/39178.rst rename to docs/source/release/v6.13.0/Muon/Algorithms/Bugfixes/Used/39178.rst diff --git a/docs/source/release/v6.13.0/Muon/Muon_Analysis/Bugfixes/39263.rst b/docs/source/release/v6.13.0/Muon/Muon_Analysis/Bugfixes/Used/39263.rst similarity index 100% rename from docs/source/release/v6.13.0/Muon/Muon_Analysis/Bugfixes/39263.rst rename to docs/source/release/v6.13.0/Muon/Muon_Analysis/Bugfixes/Used/39263.rst diff --git a/docs/source/release/v6.13.0/Reflectometry/New_features/36573.rst b/docs/source/release/v6.13.0/Reflectometry/New_features/Used/36573.rst similarity index 100% rename from docs/source/release/v6.13.0/Reflectometry/New_features/36573.rst rename to docs/source/release/v6.13.0/Reflectometry/New_features/Used/36573.rst diff --git a/docs/source/release/v6.13.0/Reflectometry/New_features/37617.rst b/docs/source/release/v6.13.0/Reflectometry/New_features/Used/37617.rst similarity index 100% rename from docs/source/release/v6.13.0/Reflectometry/New_features/37617.rst rename to docs/source/release/v6.13.0/Reflectometry/New_features/Used/37617.rst diff --git a/docs/source/release/v6.13.0/Reflectometry/New_features/37768.rst b/docs/source/release/v6.13.0/Reflectometry/New_features/Used/37768.rst similarity index 100% rename from docs/source/release/v6.13.0/Reflectometry/New_features/37768.rst rename to docs/source/release/v6.13.0/Reflectometry/New_features/Used/37768.rst diff --git a/docs/source/release/v6.13.0/Reflectometry/New_features/38504.rst b/docs/source/release/v6.13.0/Reflectometry/New_features/Used/38504.rst similarity index 100% rename from docs/source/release/v6.13.0/Reflectometry/New_features/38504.rst rename to docs/source/release/v6.13.0/Reflectometry/New_features/Used/38504.rst diff --git a/docs/source/release/v6.13.0/SANS/Bugfixes/39106.rst b/docs/source/release/v6.13.0/SANS/Bugfixes/Used/39106.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/Bugfixes/39106.rst rename to docs/source/release/v6.13.0/SANS/Bugfixes/Used/39106.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/38470.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/38470.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/38470.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/38470.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/38502.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/38502.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/38502.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/38502.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/38505.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/38505.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/38505.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/38505.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/38523.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/38523.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/38523.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/38523.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/38524.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/38524.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/38524.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/38524.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/38525.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/38525.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/38525.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/38525.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/38526.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/38526.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/38526.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/38526.rst diff --git a/docs/source/release/v6.13.0/SANS/New_features/39002.rst b/docs/source/release/v6.13.0/SANS/New_features/Used/39002.rst similarity index 100% rename from docs/source/release/v6.13.0/SANS/New_features/39002.rst rename to docs/source/release/v6.13.0/SANS/New_features/Used/39002.rst diff --git a/docs/source/release/v6.13.0/Workbench/Bugfixes/39049.rst b/docs/source/release/v6.13.0/Workbench/Bugfixes/Used/39049.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/Bugfixes/39049.rst rename to docs/source/release/v6.13.0/Workbench/Bugfixes/Used/39049.rst diff --git a/docs/source/release/v6.13.0/Workbench/Bugfixes/39247.rst b/docs/source/release/v6.13.0/Workbench/Bugfixes/Used/39247.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/Bugfixes/39247.rst rename to docs/source/release/v6.13.0/Workbench/Bugfixes/Used/39247.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/38080.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/38080.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/38080.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/38080.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/38405.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/38405.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/38405.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/38405.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/38799.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/38799.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/38799.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/38799.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/38807.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/38807.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/38807.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/38807.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/39013.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/39013.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/39013.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/39013.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/39097.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/39097.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/39097.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/39097.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/39242.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/39242.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/39242.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/39242.rst diff --git a/docs/source/release/v6.13.0/Workbench/New_features/39286.rst b/docs/source/release/v6.13.0/Workbench/New_features/Used/39286.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/New_features/39286.rst rename to docs/source/release/v6.13.0/Workbench/New_features/Used/39286.rst diff --git a/docs/source/release/v6.13.0/Workbench/SliceViewer/Bugfixes/36084.rst b/docs/source/release/v6.13.0/Workbench/SliceViewer/Bugfixes/Used/36084.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/SliceViewer/Bugfixes/36084.rst rename to docs/source/release/v6.13.0/Workbench/SliceViewer/Bugfixes/Used/36084.rst diff --git a/docs/source/release/v6.13.0/Workbench/SliceViewer/New_features/39169.rst b/docs/source/release/v6.13.0/Workbench/SliceViewer/New_features/Used/39169.rst similarity index 100% rename from docs/source/release/v6.13.0/Workbench/SliceViewer/New_features/39169.rst rename to docs/source/release/v6.13.0/Workbench/SliceViewer/New_features/Used/39169.rst diff --git a/docs/source/release/v6.13.0/diffraction.rst b/docs/source/release/v6.13.0/diffraction.rst index 8373bd778267..d8ba6de524a0 100644 --- a/docs/source/release/v6.13.0/diffraction.rst +++ b/docs/source/release/v6.13.0/diffraction.rst @@ -10,11 +10,23 @@ Powder Diffraction New features ############ -.. amalgamate:: Diffraction/Powder/New_features +- New algorithm :ref:`AlignAndFocusPowderSlim ` (VULCAN only) which is meant to replicate the functionality of :ref:`AlignAndFocusPowderFromFiles `, but performs all the work on the events directly from file. +- Several improvements to :ref:`algm-PEARLTransfit`: + + - Perform an intial fit with fixed ``GaussianFWHM`` for calibration runs + - Accounted for covariance in error calculation for effective temperature + - Added new input parameter ``RebinInEnergy`` - if False then the energy bins will be determined from the TOF bins in the input workspace and not the ``Ediv`` parameter. +- A new method named ``getFittingParameter`` has been added to Mantid::Geometry::Component class and exposed to python to access fitting parameters from components in instrument definition file +- Enable user defined sample and container geometry together with the definition of gauge volume to account for the beam size. Implementation made in :ref:`SNSPowderReduction ` and ``mantid.utils.absorptioncorrutils``. Bugfixes ############ -.. amalgamate:: Diffraction/Powder/Bugfixes +- Correct binning of output workspace of :ref:`algm-PDFFourierTransform-v2` and correct use of bin edge and bin center in evaluated integral. +- Handle the special case where runs to merge do not share common columns in :ref:`HB2AReduce `. +- Several bugs fixed in :ref:`algm-PEARLTransfit`: + + - Fixed bug in binning which produced empty bins that caused fits to Ta10 resonance to fail with default ``Ediv`` + - Corrected error propagation for effective and sample temperature Engineering Diffraction @@ -22,11 +34,26 @@ Engineering Diffraction New features ############ -.. amalgamate:: Diffraction/Engineering/New_features +- In fitting tab of :ref:`Engineering Diffraction interface` data can now be loaded that is in d-spacing as well as Time-of-flight. +- New verison of :ref:`algm-PoldiAutoCorrelation-v6` that supports the new detector geometry on POLDI post upgrade (in December 2024). For older POLDI data please use the previous version (:ref:`algm-PoldiAutoCorrelation-v5` by calling the algorithm with keyword argument Version=5). +- Helper functions in `poldi_utils` to load POLDI data post detector upgrade (currently ASCII format with no meta-data) and simulate the spectra in a :ref:`Workspace2D ` from an input powder spectrum. The functions can be imported in a script like so ``from plugins.algorithms.poldi_utils import *``. +- Renamed ``Crop Calibration`` within the ``Engineering Diffraction`` calibration interface to ``Set Calibration Region of Interest`` to more accurately reflect its functionality. +- Renamed ``Custom CalFile`` to ``Custom Grouping File`` and allowed the provided file to be ``.xml`` as well as ``.`cal``. This brings it inline with the current detector grouping IO algorithms, :ref:`algm-SaveDetectorsGrouping-v1` and :ref:`algm-LoadDetectorsGroupingFile-v1`. +- Changed the naming suffix for custom file example_group.xml from _Custom to _Custom_example_group so they don't get overwritten when custom grouping is changed (also more clear to the user what grouping is being used). +- Changed the naming suffix for cropped spectrum list: example_list from _Cropped to _Cropped_example_list so they don't get overwritten when custom grouping is changed (also more clear to the user what grouping is being used). +- Added a warning to Focusing for when the vanadium normalisation has been loaded from the ADS +- `#39139 `_ : Type driven refactor of Engineering Diffraction Interface ``GSAS-II`` model and centralisation of how ``GSAS-II`` call is configured. Refactor removes the need for hard-coded paths in favour of recursively searching for files within a user defined path. +- New algorithm :ref:`algm-CreatePoleFigureTableWorkspace` which creates a table with the information required to produce a pole figure (a collection of alphas, betas, and intensities), for use in texture analysis. Bugfixes ############ -.. amalgamate:: Diffraction/Engineering/Bugfixes +- `#38668 `_ : Disable ``Rietveld`` from :ref:`GSAS-II UI ` Refinement Method combobox options. Add on-hover tooltip to inform users that Rietveld is not currently supported. +- When Focusing, either within the interface or in a script, you should no longer be able to unknowingly apply an outdated vanadium correction. Previously, when focusing had already been run on a user defined region of interest (Custom or Cropped), the vanadium correction was calculated and saved in the ADS as ``engggui_curves_Custom`` or ``engggui_curves_Cropped``. If this ROI was then updated and recalibrated, when focus was run again, it would load the existing ``engggui_curves`` from the ADS which would be from the old ROI. Now, the naming of these files should be more unique to the specific ROI, and in the case where a file is loaded from the ADS which may be wrong, a warning is supplied to the user. +- `#39148 `_ : Resolve formatting issue within ``CEO2.cif`` causing a loop error when trying to load into Mantid Workbech using ``LoadCIF``. +- Add elements to the detector banks in ``SNAP_Definition.xml`` +- Within :ref:`algm-AbsorptionCorrection` algorithm, when ``Rasterize`` is called, it now takes both the Integration Volume Shape and the Sample Shape to calculate L1 paths. Before, it would only take the integration volume and would assume that the paths within this shape are equal to the paths within the sample. +- `#38882 `_ : Fix issue with ``GSAS-II GSASIIscriptable.py`` hard-coded path which is invalid for newer version of GSAS-II (versions 5758 and later). +- Fixed a flaky crash in :ref:`Fitting tab ` of :ref:`Engineering Diffraction interface` seen when deleting multiple workspaces in the ADS. This also fixed an issue of clearing the whole plot in the same tab when deleting workspaces in the ADS. Single Crystal Diffraction @@ -34,10 +61,11 @@ Single Crystal Diffraction New features ############ -.. amalgamate:: Diffraction/Single_Crystal/New_features +- Added ``detectorbin`` peak shape for the peaks integrated with :ref:`IntegratePeaks1DProfile ` integration algorithm. +- By accessing the detectorbin peak shape, users can now view the detector IDs and the corresponding range in the X dimension associated with each detector for each successfully integrated peak from the algorithm. Bugfixes ############ -.. amalgamate:: Diffraction/Single_Crystal/Bugfixes +- Fixed issue with :ref:`PredictPeaks ` and the ``CalculateGoniometerForCW`` option where the angle range was filtered incorrectly when not using the default goniometer convention. :ref:`Release 6.13.0 ` diff --git a/docs/source/release/v6.13.0/direct_geometry.rst b/docs/source/release/v6.13.0/direct_geometry.rst index 605f8f88ecfb..2a6cc472705b 100644 --- a/docs/source/release/v6.13.0/direct_geometry.rst +++ b/docs/source/release/v6.13.0/direct_geometry.rst @@ -10,11 +10,11 @@ General New features ############ -.. amalgamate:: Direct_Geometry/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. Bugfixes ############ -.. amalgamate:: Direct_Geometry/General/Bugfixes + CrystalField @@ -22,11 +22,11 @@ CrystalField New features ############ -.. amalgamate:: Direct_Geometry/CrystalField/New_features + Bugfixes ############ -.. amalgamate:: Direct_Geometry/CrystalField/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 MSlice @@ -34,10 +34,10 @@ MSlice New features ############ -.. amalgamate:: Direct_Geometry/MSlice/New_features + Bugfixes ############ -.. amalgamate:: Direct_Geometry/MSlice/Bugfixes + :ref:`Release 6.13.0 ` diff --git a/docs/source/release/v6.13.0/framework.rst b/docs/source/release/v6.13.0/framework.rst index 0a5259ba5026..c8a3841d5460 100644 --- a/docs/source/release/v6.13.0/framework.rst +++ b/docs/source/release/v6.13.0/framework.rst @@ -10,38 +10,80 @@ Algorithms New features ############ -.. amalgamate:: Framework/Algorithms/New_features +- :ref:`algm-PaalmanPingsAbsorptionCorrection` has been updated to use beam properties from :ref:`algm-SetBeam` to determine ``GaugeVolume`` if no volume is defined. +- :ref:`CreateDetectorTable` now has an optional argument, ``IncludeDetectorPosition``, which, if `True`, will add a column, ``Position``, to the end of the ``DetectorTable``. This column has the detector position as a ``V3D`` type object for each spectrum in the table. +- ``Divide`` now has an optional argument, ``IsDistribution``, to force the output distribution type. +- :ref:`DiffractionFocussing ` has a new optional boolean parameter ``FullBinsOnly``. When set, final bins of width less than the step-size are omitted from the output spectra. +- New algorithm :ref:`algm-CreateBootstrapWorkspaces` for creating randomly simulated samples for performing Bootstrap analysis. +- The c++ function ``getAlwaysStoreInADS`` has been exposed to python, now accessible from an instance of ``PythonAlgorithm``. This is a more reliable way than ``isChild`` to check if output workspaces are to be stored in the ADS. +- New option in :ref:`algm-GetIPTS` to maintain a list of IPTS for supplied runs. This does not persist across sessions. +- In :ref:`algm-SetGoniometer`, you can now directly pass a comma separated string of 9 values corresponding to the (row major) flattened rotation matrix. +- In :ref:`algm-MonteCarloAbsorption`, when a gauge volume has been defined with :ref:`algm-DefineGaugeVolume`, the algorithm now uses this gauge volume to generate the scattering points for calculating attenuation within the sample. +- ``AnyShapeAbsorption`` can now determine the gauge volume by using the BeamProfile +- New algorithm :ref:`algm-DebyeWallerFactorCorrectionMD` to scale the MDEvents by the inverse of Debye-Waller form factor. +- New algorithm :ref:`algm-CombineTableWorkspaces` allows combination of a pair of :ref:`Table Workspaces`, provided they have matching column names and data types. Bugfixes ############ -.. amalgamate:: Framework/Algorithms/Bugfixes +- Fixed bug when calculating pixel groups in :ref:`GenerateGroupingPowder ` where under certain conditions the number of pixels in a group was not calculated correctly. This could lead to incorrect grouping of pixels in the output workspace. The issue was caused by an incorrect handling of the pixel indices when calculating the groups. The fix ensures that the pixel indices are handled correctly, resulting in accurate grouping of pixels in the output workspace. +- In the script generated by :ref:`GeneratePythonFitScript ` titles for the subplots were replaced by meaningful legends so that labels of output subplots do not overlap. +- Fixed a bug in 'Unweighted least squares' cost function in Mantid fit. It was discovered not to work as expected when the fit was compared with scipy library. +- As part of the fix a new parameter named ``IgnoreInvalidData`` defaulted to ``false`` has been introduced into :ref:`CalculatePolynomialBackground ` and :ref:`algm-DirectILLTubeBackground` algorithms so that it can be forwarded into the :ref:`algm-Fit` algorithm. +- In :ref:`algm-PoldiFitPeaks2D` ``IgnoreInvalidData`` parameter is defaulted to ``true`` when invoking :ref:`algm-Fit` to preserve existing behaviour. +- The ``IgnoreInvalidData`` parameter defaulted to ``false`` has been introduced into :ref:`algm-ReflectometryBackgroundSubtraction` +- ``InstrumentArrayConverter`` and ``PeakData`` utility classes used in peak integration algorithms have been moved into a common module located at ``plugins.algorithms.peakdata_utils.py``. Import paths related to those classes need to be updated from ``from plugins.algorithms.IntegratePeaksSkew import InstrumentArrayConverter, PeakData`` into ``from plugins.algorithms.peakdata_utils import InstrumentArrayConverter, PeakData``. +- Fixed :ref:`ConvertUnits ` when input workspace is a :ref:`ragged workspaces ` with point data. +- Fixed an out of bounds error coming from :ref:`algm-IntegratePeaksShoeboxTOF` when integrating peaks. +- Fixes a bug in :ref:`algm-Divide` where units were not properly cleared when dividing two :ref:`ragged_workspace ` with identical Y-axis Units. This issue could cause errors in downstream data reduction workflows where the resulting workspace should be unitless. The fix ensures proper unit handling for :ref:`ragged_workspace ` division operations. +- Fix issue with :ref:`GroupDetectors ` where the algorithm would freeze on large datasets while adding EventList to the Output Workspace. Testing with TOPAZ-50006 execution time was reduced from 2+ hours to ~30 seconds. +- Fixes a bug in :ref:`algm-LoadAndMerge` where output workspaces were stored in the ADS when set not to. This caused the leaking of temporary workspaces in algorithms that call :ref:`algm-LoadAndMerge` as a child. Legacy behaviour can be achieved by passing ``StoreInADS=True`` to the algorithm. +- Add `MandatoryValidator` to property declaration in Divide algorithm +- :ref:`SaveNexusProcessed `: fix SEGFAULT due to slab size to data size mismatch, on write of ragged workspaces. Deprecated ############ -.. amalgamate:: Framework/Algorithms/Deprecated +- The AlignDetectors algorithm was deprecated in :ref:`Release 6.1 ` and has now been removed. Please use a combination of :ref:`ApplyDiffCal ` and :ref:`ConvertUnits ` instead. +- :ref:`algm-IntegratePeaksMD-v1` has been deprecated, use :ref:`algm-IntegratePeaksMD-v2` instead. +- :ref:`UnwrapMonitorsInTOF ` has been deprecated. There is no replacement. +- :ref:`UnwrapSNS ` has been deprecated. There is no replacement. +- Property ``UnwrapRef`` has been deprecated for algorithms that previously + called deprecated algorithm :ref:`UnwrapSNS `: + :ref:`AlignAndFocusPowder `, + :ref:`AlignAndFocusPowderFromFiles ` + and :ref:`SNSPowderReduction `. +- :ref:`LoadEventPreNexus ` has been deprecated. There is no replacement. +- :ref:`IntegratePeaksCWSD ` has been deprecated. There is no replacement. +- :ref:`UnwrapMonitor ` has been deprecated. There is no replacement. Removed ############ -.. amalgamate:: Framework/Algorithms/Removed +- The Transpose3D algorithm (also known as SINQTranspose3D) was deprecated in :ref:`Release 3.9.0 ` and has now been removed. Use :ref:`algm-TransposeMD` instead. +- Removed the obsolete algorithm `LoadLLB`. +- Removed the obsolete algorithm `SaveISISNexus`. It is being removed before the normal comment period rather than undergoing extensive changes to accommodate the consolidation of nexus APIs in mantid. +- Removed obsolete `LoadDSpacemap` and `SaveDSpacemap` algorithms. +- - The algorithm `CentroidPeaksMD v1` was deprecated in :ref:`Release 3.9.0 ` and has now been removed. Use :ref:`CentroidPeaksMD v2 ` instead. +- The algorithm `LoadNexusMonitors v1` was deprecated in :ref:`Release 3.9.0 ` and has now been removed. Use :ref:`LoadNexusMonitors v2 ` instead. +- The LoadSNSspec algorithm was deprecated on 2017-01-30 and has now been removed. +- Removed the obselete algorithm `NexusTester` 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 Handling @@ -49,15 +91,15 @@ Data Handling New features ############ -.. amalgamate:: Framework/Data_Handling/New_features +- :ref:`LoadSpec ` has been updated to be declared as a file loader Deprecated ############ -.. amalgamate:: Framework/Data_Handling/Deprecated +- :ref:`LoadPreNexus ` and :ref:`LoadPreNexusMonitors ` has been deprecated. There is no replacement. Removed ############ -.. amalgamate:: Framework/Data_Handling/Removed +- Remove ``SaveToSNSHistogramNexus`` because it is unused. Data Objects @@ -65,11 +107,11 @@ Data Objects New features ############ -.. amalgamate:: Framework/Data_Objects/New_features + Bugfixes ############ -.. amalgamate:: Framework/Data_Objects/Bugfixes + Python @@ -77,11 +119,36 @@ Python New features ############ -.. amalgamate:: Framework/Python/New_features +- Introduced a prototype "side-by-side" help system that includes both the legacy QtHelp-based viewer and a new Python-based Help Window using an embedded web browser (QWebEngine) to display documentation within Mantid Workbench. +- Improvements: + - Enhances the visual appearance and usability of in-app documentation. + - Supports richer HTML content and modern formatting, including MathJax for rendering mathematical equations. + - Delivers a smoother and more consistent experience when navigating help and reference material. +- Key benefits: + - Improved clarity for technical content (e.g. math and tables), more attractive and readable pages, and future potential for interactive elements in documentation. +- Makes the large offline documentation optional rather than a mandatory install, reducing installer/download size significantly. +- Improvements: + - For users who frequently access online docs or have bandwidth constraints, this saves considerable disk space (potentially hundreds of MB). + - Those who prefer local/offline usage can still opt to install the documentation package and continue working without internet access. +- Key benefits: + - Greater flexibility in how Mantid is set up — you choose whether to save space or have fully locally built docs. +- Introduced a new python algorithm `RefineSingleCrystalGoniometer` that refines the UB-matrix and goniometer offsets simultaneously. +- Improvements: + - Improves the indexing of the peaks for those cases when there is sample misorientation and `FindUBUsingIndexedPeaks` is insufficient. +- Key benefits: + - Improved indexing of peaks in special cases. +- Exposed ``Instrument.getFilename()`` and ``Instrument.setFilename()`` to python +- Adds a clear indicator in the Help Window’s toolbar showing whether Mantid is displaying **Local Docs** or **Online Docs** documentation. +- Improvements: + - Makes it obvious if you are using locally installed documentation or viewing updated online docs (default). + - Helps diagnose connection or installation issues if pages are not loading as expected. +- Key benefits: + - Immediate clarity on where help content is being retrieved from, removing guesswork. Bugfixes ############ -.. amalgamate:: Framework/Python/Bugfixes +- :class:`ConfigService.setDataSearchDirs ` will no longer crash when comma separated paths are used in the `datasearch.directories` setting of the `mantid.user.properties` file. +- Fixed a bug where the method :meth:`mantid.api.Run.addProperty` was ignoring the ``name`` and ``units`` parameters if the ``value`` was of type :class:`mantid.kernel.Property`. Now only if the ``name`` and ``units`` are empty will the existing values on the ``Property`` be used. Dependencies @@ -89,11 +156,11 @@ Dependencies New features ############ -.. amalgamate:: Framework/Dependencies/New_features +- Upgraded to Python 3.11, see release notes from Python `here `_. Also see Python's `migration guide `_ for changes that could break scripts. Bugfixes ############ -.. amalgamate:: Framework/Dependencies/Bugfixes + Build Tools @@ -101,7 +168,7 @@ Build Tools Bugfixes ############ -.. amalgamate:: Framework/Build_tools/Bugfixes +- CMake now successfully builds with ``-DUSE_SANITIZER=address``. For more details see :doc:`RunningSanitizers `. MantidWorkbench diff --git a/docs/source/release/v6.13.0/indirect_geometry.rst b/docs/source/release/v6.13.0/indirect_geometry.rst index df3b70350647..13407d51de1d 100644 --- a/docs/source/release/v6.13.0/indirect_geometry.rst +++ b/docs/source/release/v6.13.0/indirect_geometry.rst @@ -7,12 +7,13 @@ Indirect Geometry Changes New Features ------------ -.. amalgamate:: Indirect/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 Bugfixes -------- -.. amalgamate:: Indirect/Bugfixes + Algorithms @@ -20,10 +21,16 @@ Algorithms New features ############ -.. amalgamate:: Indirect/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. Bugfixes ############ -.. amalgamate:: Indirect/Algorithms/Bugfixes + :ref:`Release 6.13.0 ` diff --git a/docs/source/release/v6.13.0/inelastic.rst b/docs/source/release/v6.13.0/inelastic.rst index 12bd4b6cefb0..5f2e5f0c7639 100644 --- a/docs/source/release/v6.13.0/inelastic.rst +++ b/docs/source/release/v6.13.0/inelastic.rst @@ -7,12 +7,13 @@ Inelastic Changes New Features ------------ -.. amalgamate:: Inelastic/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. Bugfixes -------- -.. amalgamate:: Inelastic/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. Algorithms @@ -20,10 +21,10 @@ Algorithms New features ############ -.. amalgamate:: Inelastic/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. Bugfixes ############ -.. amalgamate:: Inelastic/Algorithms/Bugfixes + :ref:`Release 6.13.0 ` diff --git a/docs/source/release/v6.13.0/mantidworkbench.rst b/docs/source/release/v6.13.0/mantidworkbench.rst index 8d742f96513f..1e8780d7f30a 100644 --- a/docs/source/release/v6.13.0/mantidworkbench.rst +++ b/docs/source/release/v6.13.0/mantidworkbench.rst @@ -7,12 +7,23 @@ Mantid Workbench Changes New Features ------------ -.. amalgamate:: Workbench/New_features +- The :ref:`Python script editor ` now supports Bool syntax highlighting. +- The :ref:`Python script editor ` now supports f-string syntax highlighting. +- Users can now save multiple selected workspaces as ASCII. +- The crosshair button is disabled (invisible) in 3D plots, which include surface plot, wireframe plot and mesh plot. +- The settings widget 'Apply' button is now disabled when there are no pending changes. +- A crosshair toggle option has been added in mantidplots on the top right of the toolbar area. The crosshair button is disabled (invisible) in titled plots. +- Deprecated parameter ``Unwrap Ref`` has been removed from the Powder + Diffraction Reduction Interface. +- Added property ``errorreports.core_dumps``. Linux users can set this to the directory on their system where core dump files are put after a crash (e.g ``errorreports.core_dumps=/var/lib/apport/coredump``). + Workbench will then be able to use this property to extract useful information from the core dump file created after a crash and give that to the error reporting service. + This will help us to diagnose some problems where previously no stacktrace was available after a crash. On Linux, core dumps are now always turned on for the workbench process. Bugfixes -------- -.. amalgamate:: Workbench/Bugfixes +- The ``...`` button for a :ref:`user defined function ` is no longer obscured by the scroll bar in the :ref:`Fit Property Browser ` on macOS. +- Minimizing the sample log plot on the ``SampleLogs`` widget so that it is not visible no longer throws an error. InstrumentViewer @@ -20,11 +31,11 @@ InstrumentViewer New features ############ -.. amalgamate:: Workbench/InstrumentViewer/New_features + Bugfixes ############ -.. amalgamate:: Workbench/InstrumentViewer/Bugfixes + SliceViewer @@ -32,10 +43,10 @@ SliceViewer New features ############ -.. amalgamate:: Workbench/SliceViewer/New_features +- Added the option when plotting peaks in HKL to use the peak positions calculated from Q\ :sub:`sample` using the UB instead of peak index. Bugfixes ############ -.. amalgamate:: Workbench/SliceViewer/Bugfixes +- Sliceviwer no longer raises an error when exporting a pixel cut from a MDHistoWorkspace :ref:`Release 6.13.0 ` diff --git a/docs/source/release/v6.13.0/muon.rst b/docs/source/release/v6.13.0/muon.rst index cd7b168ceb07..7c6215e52c0d 100644 --- a/docs/source/release/v6.13.0/muon.rst +++ b/docs/source/release/v6.13.0/muon.rst @@ -11,7 +11,7 @@ Frequency Domain Analysis Bugfixes ############ -.. amalgamate:: Muon/FDA/Bugfixes + Muon Analysis @@ -19,7 +19,8 @@ Muon Analysis Bugfixes ############ -.. amalgamate:: Muon/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 `. Muon Analysis and Frequency Domain Analysis @@ -27,7 +28,7 @@ Muon Analysis and Frequency Domain Analysis Bugfixes ############ -.. amalgamate:: Muon/MA_FDA/Bugfixes + ALC @@ -35,7 +36,7 @@ ALC Bugfixes ############ -.. amalgamate:: Muon/ALC/Bugfixes + Elemental Analysis @@ -43,7 +44,7 @@ Elemental Analysis Bugfixes ############ -.. amalgamate:: Muon/Elemental_Analysis/Bugfixes + Algorithms @@ -51,6 +52,6 @@ Algorithms Bugfixes ############ -.. amalgamate:: Muon/Algorithms/Bugfixes +- Improved the numerical stability of :ref:`PhaseQuad `. This algorithm was inverting a 2x2 matrix manually, which resulted in numerically unstable results. Performance should also be improved. :ref:`Release 6.13.0 ` diff --git a/docs/source/release/v6.13.0/reflectometry.rst b/docs/source/release/v6.13.0/reflectometry.rst index c5d94bbc1500..96e7fe48a1b7 100644 --- a/docs/source/release/v6.13.0/reflectometry.rst +++ b/docs/source/release/v6.13.0/reflectometry.rst @@ -7,10 +7,19 @@ Reflectometry Changes New Features ------------ -.. amalgamate:: Reflectometry/New_features +- A new field, ``Fredrikze Input Spin State Order``, has been added to the :ref:`Experiment Settings Tab ` on the + ISIS Reflectometry interface. This allows the spin state order of the input workspace group to be supplied when + the reduction performs a Fredrikze polarisation correction. +- The flipper configuration for the input workspace group from the :ref:`interface-isis-refl`, when performing a Wildes + polarisation correction, can now be passed to the reduction by adding a parameter called ``WildesFlipperConfig`` to + your intrument's parameter file. Additionally, a default configuration of ``01,01,10,11`` has been added to POLREF's + parameter file. +- When a workspace is loaded on the ISIS Reflectometry GUI :ref:`Reduction Preview ` tab, region selectors are now added to the slice viewer plot to display any ROIs from matching experiment settings. +- The :ref:`algm-PolarizationEfficienciesWildes` algorithm now propagates errors correctly using the taylor series method (first order). A new helper class has been introduced to do this using the Eigen ``autodiff`` module to calculate partials. +- The :ref:`algm-SaveNXcanSAS` algorithm can also accept compatible Workspace Groups as input. Bugfixes -------- -.. amalgamate:: Reflectometry/Bugfixes + :ref:`Release 6.13.0 ` diff --git a/docs/source/release/v6.13.0/sans.rst b/docs/source/release/v6.13.0/sans.rst index b9116f436b4e..2bafd3ee56f5 100644 --- a/docs/source/release/v6.13.0/sans.rst +++ b/docs/source/release/v6.13.0/sans.rst @@ -7,10 +7,22 @@ SANS Changes New Features ------------ -.. amalgamate:: SANS/New_features +- :ref:`algm-SANSSave` now supports the new :ref:`algm-SavePolarizedNXcanSAS` algorithm. +- :ref:`algm-LoadNXcanSAS` can now load polarized NXcanSAS data. +- Changes have been made to ``SANSadd2`` and ``CreateSANSWavelengthPixelAdjustment`` to enable the summing of LOQ event mode data, and allow for the use of the new LOQ IDF. +- ISIS SANS Batch Reductions (such as those performed by ``WavRangeReduction`` from the + :ref:`ISIS Command Interface `) can now make use of polarization + properties defined in the V2 User File to save using :ref:`algm-SavePolarizedNXcanSAS`. +- Polarization options have been added the :ref:`sans_toml_v1-ref` format. + As a result, the most up-to-date version of SANS TOML, which supports these options, has been bumped to 2. +- Update SANS Command Line Interface to pass a save algorithm directly to the ``WavRangeReduction`` command. +- Update documentation for :ref:`scripting SANS reduction` using command line interface. +- New algorithm :ref:`algm-ReflectometryISISCalculatePolEff` added. This algorithm provides a convenient wrapper for the :ref:`algm-ReflectometryISISCreateTransmission`, :ref:`algm-PolarizationEfficienciesWildes` and :ref:`algm-JoinISISPolarizationEfficiencies` algorithms. +- Add new :ref:`algm-SavePolarizedNXcanSAS` algorithm to save reduced polarized SANS data in NXcanSAS format. Bugfixes -------- -.. amalgamate:: SANS/Bugfixes +- :ref:`ISIS_SANS_Sum_Runs_Tab-ref` in the ISIS SANS interface now maintains the sample properties + (shape, thickness, height, and width) of the runs in the added output file. :ref:`Release 6.13.0 `