Merge release notes for 2.6 (#1948)

mantidproject · Oct 9, 2023 · 956fd8f · 956fd8f
2 parents 30be6d7 + 3a7e584
commit 956fd8f
Show file tree

Hide file tree

Showing 49 changed files with 73 additions and 51 deletions.
diff --git a/docs/release_notes/2.5.rst b/docs/release_notes/2.5.rst
@@ -112,3 +112,14 @@ Developer Changes
 - #1754 : Migrate Centos7 and Ubuntu18 Docker images from DockerHub to GitHub Container Registry
 - #1757 : CLI log level only on to mantidimaging
 - #1788 : Switch to separate Windows and Linux conda packages
+
+Mantid Imaging 2.5.1
+====================
+
+This release contains backported fixes for the following issues
+
+- #1864 : Add log file normalisation to support older log file formats
+- #1865 : Be less strict when finding flat and dark
+- #1870 : Load all file in the extra digits case
+- #1887 : Better error message for corrupt TIFF file
+- #1888 : Don't return files beginning with a dot when finding related
diff --git a/docs/release_notes/2.6.rst b/docs/release_notes/2.6.rst
@@ -0,0 +1,61 @@
+Mantid Imaging 2.6
+==================
+
+This release introduces a live viewer that can be used to observe images arriving from an instrument.
+
+It also features more control when reconstructing with SPDHG, toggling ROIs in the spectrum viewer, improvements to the roation operation and performance improvements. There are also several bug fixes and updates to dependencies. For a full list of changes see below.
+
+New Features
+------------
+- #1722 : SPDHG: Allow adjusting the percent of iterations used regularisation
+- #1798 : Allow for toggling of ROI visibility in the table of ROIs within the spectrum viewer.
+- #1828 : Performance improvements for the spectrum viewer
+- #1758 : Use QFileSystemWatcher to watch for changes in the file system.
+- #1859 : Select Sample Log if found when loading a dataset
+- #1871 : Show Cuda enabled reconstruction algorithms in disabled state if no gpu is available
+- #1876 : Display filename of currently displayed image in the live viewer.
+- #1881 : Allow Live Viewer to be launched using cli argument with a specific directory
+- #1904 : Backend architecture for image scroller front-end. All relevant image metadata is now stored in a list accessible to the presenter view.
+- #1916 : Image scroller for live view
+
+Fixes
+-----
+- #1776 : Fix Redrawing of ROIs within Compare Image Stack Window
+- #1777 : More consistent menu and window naming for comparing image stack data.
+- #1778 : Fix ROIs being drawn outside of the sample images within Compare Image Stack Window
+- #1784 : Don't overwrite new metadata when loading old metadata
+- #1833 : Rotate image stack by cardinal or non-cardinal Angle. Image aspect ratio snaps to closest cardinal angle.
+- #1815 : Improve handling of NaN data within Spectrum Viewer, resolving exception error dialog pop-up within Spectrum Viewer if only dataset loaded into Mantid Imaging is removed.
+- #1864 : Add log file normalisation to support older log file formats
+- #1833 : Create dropdown menu of default degrees of rotation within operations rotate stack
+- #1865 : Be less strict when finding flat and dark
+- #1870 : Load all file in the extra digits case
+- #1875 : Additional live viewer error handling for read operations on files and improved handling of slow copies to watched directory
+- #1882 : Additional Logging of file change emit signals and reduction in file change emit signals
+- #1887 : Better error message for corrupt TIFF file
+- #1888 : Don't return files beginning with a dot when finding related
+- #1891 : Fix LiveViewer handling of deleting all files from watched directory.
+- #1894 : Fix for path in PackageWithPyInstaller
+- #1918 : Use initializer to ensure worker pool do setup
+- #1920 : Fix Renaming of ROIs
+- #1922 : Load images into live viewer on initialisation if images already present in selected directory.
+- #1929 : Handle Live Viewer window closure to resolve directory persistence when trying to switch directories.
+- #1937 : Fix adjusting recon line profile from handles
+- #1940 : Fix loading a subset of a sample when there is a log with angles
+
+Developer Changes
+-----------------
+- #962 : Type annotation improvements
+- #1792 : Update python to 3.10
+- #1796 : Add MyPy to pre-commit checks.
+- #1799 : Speed up packaged builds with boa
+- #1803 : Separate files for release notes
+- #1813 : Remove deprecated load_module()
+- #1818 : CIL -> 23.0
+- #1819 : Update yapf->0.33, MyPy->1.3.0, flake8->ruff
+- #1821 : Spectrum screenshot test
+- #1845 : Create Basic Live Viewer Window
+- #1853 : Add performance logger
+- #1889 : Refactor how focus is set for windows launched by cli so they open above the main window.
+- #1901 : Add ExecutionProfiler context manager
+- #1901 : Launch Spectrum Viewer from CLI with additional CLI argument
diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst
@@ -6,6 +6,7 @@ Release Notes
    :caption: Contents:
 
    next
+   2.6
    2.5
    2.4
    2.3

diff --git a/docs/release_notes/next/dev-1792-python-310 b/docs/release_notes/next/dev-1792-python-310
diff --git a/docs/release_notes/next/dev-1796-mypy-precommit b/docs/release_notes/next/dev-1796-mypy-precommit
diff --git a/docs/release_notes/next/dev-1799-boa b/docs/release_notes/next/dev-1799-boa
diff --git a/docs/release_notes/next/dev-1803-release-notes b/docs/release_notes/next/dev-1803-release-notes
diff --git a/docs/release_notes/next/dev-1813-remove-load_module b/docs/release_notes/next/dev-1813-remove-load_module
diff --git a/docs/release_notes/next/dev-1818-deps b/docs/release_notes/next/dev-1818-deps
diff --git a/docs/release_notes/next/dev-1819-update-yapf b/docs/release_notes/next/dev-1819-update-yapf
diff --git a/docs/release_notes/next/dev-1845-LiveViewWindow b/docs/release_notes/next/dev-1845-LiveViewWindow
diff --git a/docs/release_notes/next/dev-1853-perf-logging b/docs/release_notes/next/dev-1853-perf-logging
diff --git a/docs/release_notes/next/dev-1889-cli_launched_window_focus b/docs/release_notes/next/dev-1889-cli_launched_window_focus
diff --git a/docs/release_notes/next/dev-1901-profiling-tool b/docs/release_notes/next/dev-1901-profiling-tool
diff --git a/docs/release_notes/next/dev-1924-spectrum_viewer_cli_flag b/docs/release_notes/next/dev-1924-spectrum_viewer_cli_flag
diff --git a/docs/release_notes/next/dev-962-types b/docs/release_notes/next/dev-962-types
diff --git a/docs/release_notes/next/feature-1722-reg-prob b/docs/release_notes/next/feature-1722-reg-prob
diff --git a/docs/release_notes/next/feature-1798-roi b/docs/release_notes/next/feature-1798-roi
diff --git a/docs/release_notes/next/feature-1821-spectrum_system_test b/docs/release_notes/next/feature-1821-spectrum_system_test
diff --git a/docs/release_notes/next/feature-1828-spec-view-perf b/docs/release_notes/next/feature-1828-spec-view-perf
diff --git a/docs/release_notes/next/feature-1858-file_watcher b/docs/release_notes/next/feature-1858-file_watcher
diff --git a/docs/release_notes/next/feature-1859-select_sample_log b/docs/release_notes/next/feature-1859-select_sample_log
diff --git a/docs/release_notes/next/feature-1871-disable_cuda_recon_alg_if_no_cuda b/docs/release_notes/next/feature-1871-disable_cuda_recon_alg_if_no_cuda
diff --git a/docs/release_notes/next/feature-1876-live_viewer_display_filename b/docs/release_notes/next/feature-1876-live_viewer_display_filename
diff --git a/docs/release_notes/next/feature-1881-live_liew_cli_launch_argument b/docs/release_notes/next/feature-1881-live_liew_cli_launch_argument
diff --git a/docs/release_notes/next/feature-1904-img_scroller_backend b/docs/release_notes/next/feature-1904-img_scroller_backend
diff --git a/docs/release_notes/next/feature-1916-img_scroller_user_interface b/docs/release_notes/next/feature-1916-img_scroller_user_interface
diff --git a/docs/release_notes/next/fix-1776-redraw-roi b/docs/release_notes/next/fix-1776-redraw-roi
diff --git a/docs/release_notes/next/fix-1777-compare-image-stack b/docs/release_notes/next/fix-1777-compare-image-stack
diff --git a/docs/release_notes/next/fix-1778-compare_imgs_roi_outsite_img b/docs/release_notes/next/fix-1778-compare_imgs_roi_outsite_img
diff --git a/docs/release_notes/next/fix-1784-dont-overwrite-metadata b/docs/release_notes/next/fix-1784-dont-overwrite-metadata
diff --git a/docs/release_notes/next/fix-1805-rotate_stack_aspect_ratio b/docs/release_notes/next/fix-1805-rotate_stack_aspect_ratio
diff --git a/docs/release_notes/next/fix-1815-spec-viewer b/docs/release_notes/next/fix-1815-spec-viewer
diff --git a/docs/release_notes/next/fix-1833-rotate_stack_dropdown b/docs/release_notes/next/fix-1833-rotate_stack_dropdown
diff --git a/docs/release_notes/next/fix-1833-support_older_log_formats b/docs/release_notes/next/fix-1833-support_older_log_formats
diff --git a/docs/release_notes/next/fix-1865-find-flat-dark b/docs/release_notes/next/fix-1865-find-flat-dark
diff --git a/docs/release_notes/next/fix-1870-load-all-files b/docs/release_notes/next/fix-1870-load-all-files
diff --git a/docs/release_notes/next/fix-1875-live_viewer_file_state_validation b/docs/release_notes/next/fix-1875-live_viewer_file_state_validation
diff --git a/docs/release_notes/next/fix-1882-reduce_file_update_signal_emits b/docs/release_notes/next/fix-1882-reduce_file_update_signal_emits
diff --git a/docs/release_notes/next/fix-1887-corrupt-file-msg b/docs/release_notes/next/fix-1887-corrupt-file-msg
diff --git a/docs/release_notes/next/fix-1888-ignore-dotfiles b/docs/release_notes/next/fix-1888-ignore-dotfiles
diff --git a/docs/release_notes/next/fix-1891-fix-live_viewer_delete_all_files b/docs/release_notes/next/fix-1891-fix-live_viewer_delete_all_files
diff --git a/docs/release_notes/next/fix-1894-fix-pyinstaller-path b/docs/release_notes/next/fix-1894-fix-pyinstaller-path
diff --git a/docs/release_notes/next/fix-1918-pool-start b/docs/release_notes/next/fix-1918-pool-start
diff --git a/docs/release_notes/next/fix-1920-rename-roi b/docs/release_notes/next/fix-1920-rename-roi
diff --git a/docs/release_notes/next/fix-1922-live_view_image_load_on_init b/docs/release_notes/next/fix-1922-live_view_image_load_on_init
diff --git a/docs/release_notes/next/fix-1929-live_view_window_closure b/docs/release_notes/next/fix-1929-live_view_window_closure
diff --git a/docs/release_notes/next/fix-1937-recon-line-prof b/docs/release_notes/next/fix-1937-recon-line-prof
diff --git a/docs/release_notes/next/fix-1940-load-subset-with-angles b/docs/release_notes/next/fix-1940-load-subset-with-angles
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ Release Notes @@
        :caption: Contents:
        next
+.6
 .5
 .4
 .3
@@ Expand Down @@