From aa2725a0c1fd090a921fe54bb42f0f64e6917d51 Mon Sep 17 00:00:00 2001
From: Conor Finn <conor.finn@stfc.ac.uk>
Date: Thu, 16 Jan 2020 09:02:06 +0000
Subject: [PATCH] RE #26849 Add cropping info to documentation
---
.../interfaces/Engineering Diffraction 2.rst | 33 +++++++++++++++----
1 file changed, 26 insertions(+), 7 deletions(-)
diff --git a/docs/source/interfaces/Engineering Diffraction 2.rst b/docs/source/interfaces/Engineering Diffraction 2.rst
index c2c7bf1d40e..d5bd85d3d55 100644
--- a/docs/source/interfaces/Engineering Diffraction 2.rst
+++ b/docs/source/interfaces/Engineering Diffraction 2.rst
@@ -11,7 +11,9 @@ Interface Overview
This custom interface will integrate several tasks related to engineering
diffraction. In its current state it provides functionality for creating
-new calibration files. This interface is under active development.
+and loading calibration files, and focusing ENGINX run files.
+
+This interface is under active development.
General Options
^^^^^^^^^^^^^^^
@@ -27,6 +29,11 @@ Instrument
?
Show this documentation page.
+Settings
+ Provides a range of options that apply across the entire interface, currently
+ providing the option to change the default output directory and force the
+ recalculation of the vanadium correction files.
+
Close
Close the interface.
@@ -37,9 +44,10 @@ Red Stars
Calibration
-----------
-This tab currently provides a graphical interface to create new calibrations
-and visualise them. It also allows for the loading of GSAS parameter files created
-by the calibration process to load a previously created calibration into the interface.
+This tab currently provides a graphical interface to create new calibrations, using the
+:ref:`EnggCalibrate<algm-EnggCalibrate>` algorithm, and visualise them.
+It also allows for the loading of GSAS parameter files created by the calibration process
+to load a previously created calibration into the interface.
When loading an existing calibration, the fields for creating a new calibration will be
automatically filled, allowing the recreation of the workspaces and plots generated by
@@ -52,14 +60,18 @@ Creating a new calibration file generates 3 GSAS instrument parameter files,
one covering all banks and separate ones for each individual bank. All 3 files are written
to the same directory:
-`Engineering_Mantid/Calibration/`
+`<CHOSEN_OUTPUT_DIRECTORY>/Calibration/`
If an RB number has been specified the files will also be saved to a user directory
in the base directory:
-`Engineering_Mantid/User/RBNumber/Calibration/`
+`<CHOSEN_OUTPUT_DIRECTORY>/User/RBNumber/Calibration/`
+
+Cropping
+^^^^^^^^
-Currently, the `Engineering_Mantid` directory is created in the current user's home directory.
+The interface also provides the ability to restrict a new calibration to one of the two banks
+or to a custom list of spectra.
Parameters
^^^^^^^^^^
@@ -74,6 +86,13 @@ Calibration Sample Number
Path
The path to the GSAS parameter file to be loaded.
+Bank/Spectra
+ Select a bank to crop to or specify a custom spectra will be entered.
+
+Custom Spectra
+ A comma separated list of spectra to restrict the calibration to. Can be provided as single spectrum numbers
+ or ranges using hyphens (e.g. 14-150, 405, 500-600).
+
Focus
-----
--
GitLab