Make naming of NXcanSAS consistent.

cailafinn · cailafinn · commit 7caa6d19ec2b · 2025-05-16T11:52:58.000+01:00
The correct format of NXcanSAS has a lowercase can. Make this the place throughout the project to avoid confusion. RE mantidproject#38523
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SANS/SANSSave.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SANS/SANSSave.py
@@ -110,7 +110,7 @@ def PyInit(self):
 
         self.setPropertyGroup("Nexus", "FileFormats")
         self.setPropertyGroup("CanSAS", "FileFormats")
-        self.setPropertyGroup("NXCanSAS", "FileFormats")
+        self.setPropertyGroup("NXcanSAS", "FileFormats")
         self.setPropertyGroup("PolarizedNXcanSAS", "FileFormats")
         self.setPropertyGroup("NistQxy", "FileFormats")
         self.setPropertyGroup("RKH", "FileFormats")
@@ -312,11 +312,11 @@ def _validate_workspace(self, errors, input_workspace):
     def _validate_pol_props(self, errors):
         polarization_props = self.getProperty("PolarizationProps").value
         if not polarization_props:
-            errors.update({"PolarizationProps": "PolarizationProps must be set to use SavePolarizedNXCanSAS."})
+            errors.update({"PolarizationProps": "PolarizationProps must be set to use SavePolarizedNXcanSAS."})
             return
         if "InputSpinStates" not in polarization_props.keys():
             errors.update(
-                {"PolarizationProps": "Missing property for SavePolarizedNXCanSAS. These properties are missing: InputSpinStates."}
+                {"PolarizationProps": "Missing property for SavePolarizedNXcanSAS. These properties are missing: InputSpinStates."}
             )
 
     def _get_file_formats(self):
diff --git a/Testing/SystemTests/tests/framework/ISIS/SANS/WORKFLOWS/SANSSaveTest.py b/Testing/SystemTests/tests/framework/ISIS/SANS/WORKFLOWS/SANSSaveTest.py
@@ -66,7 +66,7 @@ def test_that_run_number_properties_can_be_set(self):
             "UseZeroErrorFree": False,
             "Nexus": False,
             "CanSAS": False,
-            "NXCanSAS": True,
+            "NXcanSAS": True,
             "NistQxy": False,
             "RKH": False,
             "CSV": False,
@@ -92,7 +92,7 @@ def test_that_workspace_can_be_saved_without_zero_error_free_option(self):
             "UseZeroErrorFree": use_zero_errors_free,
             "Nexus": True,
             "CanSAS": True,
-            "NXCanSAS": True,
+            "NXcanSAS": True,
             "NistQxy": True,
             "RKH": True,
             "CSV": True,
@@ -132,7 +132,7 @@ def test_that_nistqxy_cannot_be_saved_if_axis_is_spectra_axis(self):
             "UseZeroErrorFree": use_zero_errors_free,
             "Nexus": False,
             "CanSAS": False,
-            "NXCanSAS": False,
+            "NXcanSAS": False,
             "NistQxy": True,
             "RKH": False,
             "CSV": False,
@@ -159,7 +159,7 @@ def test_that_if_no_format_is_selected_raises(self):
             "UseZeroErrorFree": use_zero_errors_free,
             "Nexus": False,
             "CanSAS": False,
-            "NXCanSAS": False,
+            "NXcanSAS": False,
             "NistQxy": False,
             "RKH": False,
             "CSV": False,
@@ -186,7 +186,7 @@ def test_that_zero_error_is_removed(self):
             "UseZeroErrorFree": use_zero_errors_free,
             "Nexus": True,
             "CanSAS": False,
-            "NXCanSAS": False,
+            "NXcanSAS": False,
             "NistQxy": False,
             "RKH": False,
             "CSV": False,
@@ -223,12 +223,12 @@ def test_polarization_props_must_be_set_when_polarized_nx_can_sas_set(self):
         save_options = {
             "InputWorkspace": workspace,
             "Filename": file_name,
-            "PolarizedNXCanSAS": True,
+            "PolarizedNXcanSAS": True,
         }
         save_alg = create_unmanaged_algorithm(save_name, **save_options)
         save_alg.setRethrows(True)
         # Act
-        self.assertRaisesRegex(RuntimeError, "PolarizationProps must be set to use SavePolarizedNXCanSAS.", save_alg.execute)
+        self.assertRaisesRegex(RuntimeError, "PolarizationProps must be set to use SavePolarizedNXcanSAS.", save_alg.execute)
 
     def test_workspace_must_be_group_to_use_polarized_nx_can_sas(self):
         # Arrange
@@ -238,7 +238,7 @@ def test_workspace_must_be_group_to_use_polarized_nx_can_sas(self):
         save_options = {
             "InputWorkspace": workspace,
             "Filename": file_name,
-            "PolarizedNXCanSAS": True,
+            "PolarizedNXcanSAS": True,
         }
         save_alg = create_unmanaged_algorithm(save_name, **save_options)
         save_alg.setRethrows(True)
@@ -258,13 +258,13 @@ def test_polarization_props_throws_when_any_mandatory_properties_unset(self):
         }
         with self.assertRaisesRegex(
             RuntimeError,
-            ".*PolarizationProps: Missing property for SavePolarizedNXCanSAS. These properties are missing: InputSpinStates",
+            ".*PolarizationProps: Missing property for SavePolarizedNXcanSAS. These properties are missing: InputSpinStates",
         ):
             # Act
             SANSSave(
                 InputWorkspace=workspace,
                 Filename=file_name,
-                PolarizedNXCanSAS=True,
+                PolarizedNXcanSAS=True,
                 PolarizationProps=pol_props,
             )
 
diff --git a/docs/source/release/v4.1.0/sans.rst b/docs/source/release/v4.1.0/sans.rst
@@ -29,7 +29,7 @@ Improvements
 - The **diagnostic** page icon has been changed from a question mark to a stethoscope, to distinguish it from the **Help** page icon. The **Export Table** button now has an icon. There have been minor icon changes elsewhere on the interface.
 - Sample thickness, height, and width can be read from a batch file. These parameters are also included in the batch file generated from exporting the table.
 - The beam centre HAB/LAB update checkboxes are automatically deselected if you select LAB/HAB as the reduction mode, respectively.
-- The run numbers for sample transmission, sample direct, can scatter, and can direct workspaces are now added to NXCanSAS and CanSAS files.
+- The run numbers for sample transmission, sample direct, can scatter, and can direct workspaces are now added to NXcanSAS and CanSAS files.
 
 
 Bug Fixes
diff --git a/docs/source/release/v5.1.0/sans.rst b/docs/source/release/v5.1.0/sans.rst
@@ -12,7 +12,7 @@ New
 ###
 
 - A new algorithm :ref:`SANSILLParameterScan <algm-SANSILLParameterScan>` added, used to treat data from ILL's D16 on omega scan mode.
-- :ref:`SaveCanSAS1D <algm-SaveCanSAS1D>` and :ref:`SaveNXCanSAS <algm-SaveNXCanSAS>` now include the batch
+- :ref:`SaveCanSAS1D <algm-SaveCanSAS1D>` and :ref:`SaveNXcanSAS <algm-SaveNXcanSAS>` now include the batch
   file name in their metadata if one was used to produce the output.
 
 Improvements
diff --git a/docs/source/release/v6.9.0/sans.rst b/docs/source/release/v6.9.0/sans.rst
@@ -7,7 +7,7 @@ SANS Changes
 
 New Features
 ------------
-- Metadata indicating the subtracted workspace and the scale factor is now saved to CanSAS1D and NXCanSAS subtracted
+- Metadata indicating the subtracted workspace and the scale factor is now saved to CanSAS1D and NXcanSAS subtracted
   output files when a :ref:`ISIS_SANS_scaled_background-ref` has been performed. This information is located in
   ``SASprocess``.
 - All beam centre settings can now be left uncommented in the TOML file. The appropriate beam centre values will now be
diff --git a/scripts/SANS/sans/algorithm_detail/save_workspace.py b/scripts/SANS/sans/algorithm_detail/save_workspace.py
@@ -27,7 +27,7 @@ def save_to_file(workspace, file_format, file_name, additional_properties, addit
     :param file_name: the file name.
     :param additional_properties: a dict of additional save algorithm inputs
             e.g. Transmission and TransmissionCan for SaveCanSAS1D-v2
-    :param additional_run_numbers: a dict of workspace type to run number. Used in SaveNXCanSAS only.
+    :param additional_run_numbers: a dict of workspace type to run number. Used in SaveNXcanSAS only.
     :return:
     """
     save_options = {"InputWorkspace": workspace}
diff --git a/scripts/SANS/sans/command_interface/ISISCommandInterface.py b/scripts/SANS/sans/command_interface/ISISCommandInterface.py
@@ -532,7 +532,7 @@ def set_save(
                     save_algs.append(SaveType.CAN_SAS)
                 case "SaveCSV":
                     save_algs.append(SaveType.CSV)
-                case "SaveNXCanSAS":
+                case "SaveNXcanSAS":
                     save_algs.append(SaveType.NX_CAN_SAS)
                 case _:
                     raise RuntimeError(f"The save format {key} is not known")
