diff --git a/docs/release_notes/2.5.rst b/docs/release_notes/2.5.rst index 3f3951a53fc..98449cce7c0 100644 --- 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 new file mode 100644 index 00000000000..1f96b27eef5 --- /dev/null +++ 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 index d67f93cb6cf..5939184f979 100644 --- 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 deleted file mode 100644 index 7e66efef1f5..00000000000 --- a/docs/release_notes/next/dev-1792-python-310 +++ /dev/null @@ -1 +0,0 @@ -#1792 : Update python to 3.10 diff --git a/docs/release_notes/next/dev-1796-mypy-precommit b/docs/release_notes/next/dev-1796-mypy-precommit deleted file mode 100644 index b7b492cb4cb..00000000000 --- a/docs/release_notes/next/dev-1796-mypy-precommit +++ /dev/null @@ -1 +0,0 @@ -#1796 : Add MyPy to pre-commit checks. diff --git a/docs/release_notes/next/dev-1799-boa b/docs/release_notes/next/dev-1799-boa deleted file mode 100644 index 9e49b9e05bb..00000000000 --- a/docs/release_notes/next/dev-1799-boa +++ /dev/null @@ -1 +0,0 @@ -#1799 : Speed up packaged builds with boa diff --git a/docs/release_notes/next/dev-1803-release-notes b/docs/release_notes/next/dev-1803-release-notes deleted file mode 100644 index 63aa0cc459c..00000000000 --- a/docs/release_notes/next/dev-1803-release-notes +++ /dev/null @@ -1,2 +0,0 @@ -#1803 : Separate files for release notes - diff --git a/docs/release_notes/next/dev-1813-remove-load_module b/docs/release_notes/next/dev-1813-remove-load_module deleted file mode 100644 index 84e4365fe69..00000000000 --- a/docs/release_notes/next/dev-1813-remove-load_module +++ /dev/null @@ -1 +0,0 @@ -#1813 : Remove deprecated load_module() diff --git a/docs/release_notes/next/dev-1818-deps b/docs/release_notes/next/dev-1818-deps deleted file mode 100644 index 7e2c71c96da..00000000000 --- a/docs/release_notes/next/dev-1818-deps +++ /dev/null @@ -1,2 +0,0 @@ -#1818 : CIL -> 23.0 - diff --git a/docs/release_notes/next/dev-1819-update-yapf b/docs/release_notes/next/dev-1819-update-yapf deleted file mode 100644 index 336ce8ecc1c..00000000000 --- a/docs/release_notes/next/dev-1819-update-yapf +++ /dev/null @@ -1 +0,0 @@ -#1819 : Update yapf->0.33, MyPy->1.3.0, flake8->ruff diff --git a/docs/release_notes/next/dev-1845-LiveViewWindow b/docs/release_notes/next/dev-1845-LiveViewWindow deleted file mode 100644 index 616dba53112..00000000000 --- a/docs/release_notes/next/dev-1845-LiveViewWindow +++ /dev/null @@ -1,2 +0,0 @@ -#1845 : Create Basic Live Viewer Window - diff --git a/docs/release_notes/next/dev-1853-perf-logging b/docs/release_notes/next/dev-1853-perf-logging deleted file mode 100644 index 9b24816a12a..00000000000 --- a/docs/release_notes/next/dev-1853-perf-logging +++ /dev/null @@ -1 +0,0 @@ -#1853 : Add performance logger diff --git a/docs/release_notes/next/dev-1889-cli_launched_window_focus b/docs/release_notes/next/dev-1889-cli_launched_window_focus deleted file mode 100644 index 20268d1b39d..00000000000 --- a/docs/release_notes/next/dev-1889-cli_launched_window_focus +++ /dev/null @@ -1 +0,0 @@ -#1889 : Refactor how focus is set for windows launched by cli so they open above the main window. diff --git a/docs/release_notes/next/dev-1901-profiling-tool b/docs/release_notes/next/dev-1901-profiling-tool deleted file mode 100644 index ba88b8ff263..00000000000 --- a/docs/release_notes/next/dev-1901-profiling-tool +++ /dev/null @@ -1 +0,0 @@ -#1901 : Add ExecutionProfiler context manager diff --git a/docs/release_notes/next/dev-1924-spectrum_viewer_cli_flag b/docs/release_notes/next/dev-1924-spectrum_viewer_cli_flag deleted file mode 100644 index 63f5cd64646..00000000000 --- a/docs/release_notes/next/dev-1924-spectrum_viewer_cli_flag +++ /dev/null @@ -1 +0,0 @@ -#1901 : Launch Spectrum Viewer from CLI with additional CLI argument \ No newline at end of file diff --git a/docs/release_notes/next/dev-962-types b/docs/release_notes/next/dev-962-types deleted file mode 100644 index e30d8368f65..00000000000 --- a/docs/release_notes/next/dev-962-types +++ /dev/null @@ -1,2 +0,0 @@ -#962 : Type annotation improvements - diff --git a/docs/release_notes/next/feature-1722-reg-prob b/docs/release_notes/next/feature-1722-reg-prob deleted file mode 100644 index d3e8e7018bc..00000000000 --- a/docs/release_notes/next/feature-1722-reg-prob +++ /dev/null @@ -1,2 +0,0 @@ -#1722 : SPDHG: Allow adjusting the percent of iterations used regularisation - diff --git a/docs/release_notes/next/feature-1798-roi b/docs/release_notes/next/feature-1798-roi deleted file mode 100644 index d4c1d157ba6..00000000000 --- a/docs/release_notes/next/feature-1798-roi +++ /dev/null @@ -1 +0,0 @@ -#1798 : Allow for toggling of ROI visibility in the table of ROIs within the spectrum viewer. diff --git a/docs/release_notes/next/feature-1821-spectrum_system_test b/docs/release_notes/next/feature-1821-spectrum_system_test deleted file mode 100644 index d4c1d157ba6..00000000000 --- a/docs/release_notes/next/feature-1821-spectrum_system_test +++ /dev/null @@ -1 +0,0 @@ -#1798 : Allow for toggling of ROI visibility in the table of ROIs within the spectrum viewer. diff --git a/docs/release_notes/next/feature-1828-spec-view-perf b/docs/release_notes/next/feature-1828-spec-view-perf deleted file mode 100644 index 7989fbf3b99..00000000000 --- a/docs/release_notes/next/feature-1828-spec-view-perf +++ /dev/null @@ -1 +0,0 @@ -#1828 : Performance improvements for the spectrum viewer diff --git a/docs/release_notes/next/feature-1858-file_watcher b/docs/release_notes/next/feature-1858-file_watcher deleted file mode 100644 index 24bb87c370f..00000000000 --- a/docs/release_notes/next/feature-1858-file_watcher +++ /dev/null @@ -1 +0,0 @@ -#1758 : Use QFileSystemWatcher to watch for changes in the file system. diff --git a/docs/release_notes/next/feature-1859-select_sample_log b/docs/release_notes/next/feature-1859-select_sample_log deleted file mode 100644 index 4b15e6dec08..00000000000 --- a/docs/release_notes/next/feature-1859-select_sample_log +++ /dev/null @@ -1 +0,0 @@ -#1859 : Select Sample Log if found when loading a dataset 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 deleted file mode 100644 index d91b55f67bf..00000000000 --- a/docs/release_notes/next/feature-1871-disable_cuda_recon_alg_if_no_cuda +++ /dev/null @@ -1 +0,0 @@ -#1871 : Show Cuda enabled reconstruction algorithms in disabled state if no gpu is available diff --git a/docs/release_notes/next/feature-1876-live_viewer_display_filename b/docs/release_notes/next/feature-1876-live_viewer_display_filename deleted file mode 100644 index 86a9b88184d..00000000000 --- a/docs/release_notes/next/feature-1876-live_viewer_display_filename +++ /dev/null @@ -1 +0,0 @@ -#1876 : Display filename of currently displayed image in the live viewer. 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 deleted file mode 100644 index 2b920cce7e5..00000000000 --- a/docs/release_notes/next/feature-1881-live_liew_cli_launch_argument +++ /dev/null @@ -1 +0,0 @@ -#1881 : Allow Live Viewer to be launched using cli argument with a specific directory diff --git a/docs/release_notes/next/feature-1904-img_scroller_backend b/docs/release_notes/next/feature-1904-img_scroller_backend deleted file mode 100644 index 541ebe3c6d2..00000000000 --- a/docs/release_notes/next/feature-1904-img_scroller_backend +++ /dev/null @@ -1 +0,0 @@ -#1904 : Backend architecture for image scroller front-end. All relevant image metadata is now stored in a list accessible to the presenter view. diff --git a/docs/release_notes/next/feature-1916-img_scroller_user_interface b/docs/release_notes/next/feature-1916-img_scroller_user_interface deleted file mode 100644 index 7faef01b32d..00000000000 --- a/docs/release_notes/next/feature-1916-img_scroller_user_interface +++ /dev/null @@ -1 +0,0 @@ -#1916 : Image scroller for live view diff --git a/docs/release_notes/next/fix-1776-redraw-roi b/docs/release_notes/next/fix-1776-redraw-roi deleted file mode 100644 index ee860b4f53e..00000000000 --- a/docs/release_notes/next/fix-1776-redraw-roi +++ /dev/null @@ -1 +0,0 @@ -#1776 : Fix Redrawing of ROIs within Compare Image Stack Window diff --git a/docs/release_notes/next/fix-1777-compare-image-stack b/docs/release_notes/next/fix-1777-compare-image-stack deleted file mode 100644 index e2b6277610e..00000000000 --- a/docs/release_notes/next/fix-1777-compare-image-stack +++ /dev/null @@ -1 +0,0 @@ -#1777 : More consistent menu and window naming for comparing image stack data. 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 deleted file mode 100644 index eb1838add94..00000000000 --- a/docs/release_notes/next/fix-1778-compare_imgs_roi_outsite_img +++ /dev/null @@ -1 +0,0 @@ -#1778 : Fix ROIs being drawn outside of the sample images within Compare Image Stack Window \ No newline at end of file diff --git a/docs/release_notes/next/fix-1784-dont-overwrite-metadata b/docs/release_notes/next/fix-1784-dont-overwrite-metadata deleted file mode 100644 index 63db6755805..00000000000 --- a/docs/release_notes/next/fix-1784-dont-overwrite-metadata +++ /dev/null @@ -1 +0,0 @@ -#1784 : Don't overwrite new metadata when loading old 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 deleted file mode 100644 index 9df84cd3f2f..00000000000 --- a/docs/release_notes/next/fix-1805-rotate_stack_aspect_ratio +++ /dev/null @@ -1 +0,0 @@ -#1833 : Rotate image stack by cardinal or non-cardinal Angle. Image aspect ratio snaps to closest cardinal angle. diff --git a/docs/release_notes/next/fix-1815-spec-viewer b/docs/release_notes/next/fix-1815-spec-viewer deleted file mode 100644 index 777f03a3ff1..00000000000 --- a/docs/release_notes/next/fix-1815-spec-viewer +++ /dev/null @@ -1 +0,0 @@ -#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. diff --git a/docs/release_notes/next/fix-1833-rotate_stack_dropdown b/docs/release_notes/next/fix-1833-rotate_stack_dropdown deleted file mode 100644 index f8e90058fa9..00000000000 --- a/docs/release_notes/next/fix-1833-rotate_stack_dropdown +++ /dev/null @@ -1 +0,0 @@ -#1833 : Create dropdown menu of default degrees of rotation within operations rotate stack diff --git a/docs/release_notes/next/fix-1833-support_older_log_formats b/docs/release_notes/next/fix-1833-support_older_log_formats deleted file mode 100644 index a6e17b61b37..00000000000 --- a/docs/release_notes/next/fix-1833-support_older_log_formats +++ /dev/null @@ -1 +0,0 @@ -#1864 : Add log file normalisation to support older log file formats \ No newline at end of file diff --git a/docs/release_notes/next/fix-1865-find-flat-dark b/docs/release_notes/next/fix-1865-find-flat-dark deleted file mode 100644 index c5bc8a177ba..00000000000 --- a/docs/release_notes/next/fix-1865-find-flat-dark +++ /dev/null @@ -1 +0,0 @@ -#1865 : Be less strict when finding flat and dark diff --git a/docs/release_notes/next/fix-1870-load-all-files b/docs/release_notes/next/fix-1870-load-all-files deleted file mode 100644 index 02a5034711d..00000000000 --- a/docs/release_notes/next/fix-1870-load-all-files +++ /dev/null @@ -1 +0,0 @@ -#1870 : Load all file in the extra digits case 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 deleted file mode 100644 index 184b61685a9..00000000000 --- a/docs/release_notes/next/fix-1875-live_viewer_file_state_validation +++ /dev/null @@ -1 +0,0 @@ -#1875 : Additional live viewer error handling for read operations on files and improved handling of slow copies to watched directory 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 deleted file mode 100644 index 6869bd3c22c..00000000000 --- a/docs/release_notes/next/fix-1882-reduce_file_update_signal_emits +++ /dev/null @@ -1 +0,0 @@ -#1882 : Additional Logging of file change emit signals and reduction in file change emit signals diff --git a/docs/release_notes/next/fix-1887-corrupt-file-msg b/docs/release_notes/next/fix-1887-corrupt-file-msg deleted file mode 100644 index 7b1debbd3b2..00000000000 --- a/docs/release_notes/next/fix-1887-corrupt-file-msg +++ /dev/null @@ -1 +0,0 @@ -#1887 : Better error message for corrupt TIFF file diff --git a/docs/release_notes/next/fix-1888-ignore-dotfiles b/docs/release_notes/next/fix-1888-ignore-dotfiles deleted file mode 100644 index aea7515b537..00000000000 --- a/docs/release_notes/next/fix-1888-ignore-dotfiles +++ /dev/null @@ -1 +0,0 @@ -#1888 : Don't return files beginning with a dot when finding related 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 deleted file mode 100644 index e2d71066c5b..00000000000 --- a/docs/release_notes/next/fix-1891-fix-live_viewer_delete_all_files +++ /dev/null @@ -1 +0,0 @@ -#1891 : Fix LiveViewer handling of deleting all files from watched directory. diff --git a/docs/release_notes/next/fix-1894-fix-pyinstaller-path b/docs/release_notes/next/fix-1894-fix-pyinstaller-path deleted file mode 100644 index 044080a2641..00000000000 --- a/docs/release_notes/next/fix-1894-fix-pyinstaller-path +++ /dev/null @@ -1 +0,0 @@ -#1894 : Fix for path in PackageWithPyInstaller diff --git a/docs/release_notes/next/fix-1918-pool-start b/docs/release_notes/next/fix-1918-pool-start deleted file mode 100644 index d0b3a530fca..00000000000 --- a/docs/release_notes/next/fix-1918-pool-start +++ /dev/null @@ -1 +0,0 @@ -#1918 : Use initializer to ensure worker pool do setup diff --git a/docs/release_notes/next/fix-1920-rename-roi b/docs/release_notes/next/fix-1920-rename-roi deleted file mode 100644 index ea867503a5d..00000000000 --- a/docs/release_notes/next/fix-1920-rename-roi +++ /dev/null @@ -1 +0,0 @@ -#1920 : Fix Renaming of ROIs 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 deleted file mode 100644 index 275633443df..00000000000 --- a/docs/release_notes/next/fix-1922-live_view_image_load_on_init +++ /dev/null @@ -1 +0,0 @@ -#1922 : Load images into live viewer on initialisation if images already present in selected directory. diff --git a/docs/release_notes/next/fix-1929-live_view_window_closure b/docs/release_notes/next/fix-1929-live_view_window_closure deleted file mode 100644 index 8321c5d7722..00000000000 --- a/docs/release_notes/next/fix-1929-live_view_window_closure +++ /dev/null @@ -1 +0,0 @@ -#1929 : Handle Live Viewer window closure to resolve directory persistence when trying to switch directories. \ No newline at end of file diff --git a/docs/release_notes/next/fix-1937-recon-line-prof b/docs/release_notes/next/fix-1937-recon-line-prof deleted file mode 100644 index ccbc00cc4ed..00000000000 --- a/docs/release_notes/next/fix-1937-recon-line-prof +++ /dev/null @@ -1 +0,0 @@ -#1937 : Fix adjusting recon line profile from handles diff --git a/docs/release_notes/next/fix-1940-load-subset-with-angles b/docs/release_notes/next/fix-1940-load-subset-with-angles deleted file mode 100644 index 00838371b1f..00000000000 --- a/docs/release_notes/next/fix-1940-load-subset-with-angles +++ /dev/null @@ -1 +0,0 @@ -#1940 : Fix loading a subset of a sample when there is a log with angles