Skip to content
Snippets Groups Projects
Commit 28b7f88e authored by David Fairbrother's avatar David Fairbrother
Browse files

Re #19575 Formatting and link fixes

parent 47c343a1
No related merge requests found
...@@ -297,9 +297,9 @@ method. ...@@ -297,9 +297,9 @@ method.
Accepted values are: **True** or **False** Accepted values are: **True** or **False**
*Note: If this is set to 'True' *Note: If this is set to 'True'*
:ref:`multiple_scattering_gem_isis-powder-diffraction-ref` :ref:`multiple_scattering_gem_isis-powder-diffraction-ref`
must be set* *must be set*
Example Input: Example Input:
...@@ -511,9 +511,9 @@ in d-spacing will be present. ...@@ -511,9 +511,9 @@ in d-spacing will be present.
Accepted values are: **dSpacing** and **TOF** Accepted values are: **dSpacing** and **TOF**
*Note: All units will still be saved out in the *Note: All units will still be saved out in the*
:ref:`output_directory_gem_isis-powder-diffraction-ref` :ref:`output_directory_gem_isis-powder-diffraction-ref`
regardless of this property* *regardless of this property*
*Note: This parameter is not case sensitive* *Note: This parameter is not case sensitive*
...@@ -640,7 +640,7 @@ Determines the spline coefficient to use after processing ...@@ -640,7 +640,7 @@ Determines the spline coefficient to use after processing
the vanadium in :ref:`create_vanadium_gem_isis-powder-diffraction-ref` the vanadium in :ref:`create_vanadium_gem_isis-powder-diffraction-ref`
method. For more details see: :ref:`SplineBackground <algm-SplineBackground>` method. For more details see: :ref:`SplineBackground <algm-SplineBackground>`
*Note that if this value is changed *create_vanadium* *Note that if this value is changed 'create_vanadium'
will need to be called again.* will need to be called again.*
On GEM this is set to the following: On GEM this is set to the following:
......
...@@ -205,12 +205,14 @@ This parameter should be the full path to the calibration folder. ...@@ -205,12 +205,14 @@ This parameter should be the full path to the calibration folder.
Within the folder the following should be present: Within the folder the following should be present:
- Grouping .cal files: - Grouping .cal files:
- :ref:`tt35_grouping_filename_pearl_isis-powder-diffraction-ref` - :ref:`tt35_grouping_filename_pearl_isis-powder-diffraction-ref`
- :ref:`tt70_grouping_filename_pearl_isis-powder-diffraction-ref` - :ref:`tt70_grouping_filename_pearl_isis-powder-diffraction-ref`
- :ref:`tt80_grouping_filename_pearl_isis-powder-diffraction-ref` - :ref:`tt88_grouping_filename_pearl_isis-powder-diffraction-ref`
- Vanadium Absorption File - Vanadium Absorption File
(see: :ref:`vanadium_absorb_filename_pearl_isis-powder-diffraction-ref`) (see: :ref:`vanadium_absorb_filename_pearl_isis-powder-diffraction-ref`)
- Folder(s) with the label name specified in mapping file (e.g. "1_1") - Folder(s) with the label name specified in mapping file (e.g. "1_1")
- Inside each folder should be the offset file with name specified in mapping file - Inside each folder should be the offset file with name specified in mapping file
The script will also save out vanadium splines into the relevant The script will also save out vanadium splines into the relevant
...@@ -230,7 +232,7 @@ calibration_mapping_file ...@@ -230,7 +232,7 @@ calibration_mapping_file
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
This parameter gives the full path to the YAML file containing the This parameter gives the full path to the YAML file containing the
calibration mapping. For more details on this file see: calibration mapping. For more details on this file see:
:ref:`calibration_mapping_pearl-isis-powder-ref` :ref:`calibration_mapping_pearl_isis-powder-diffraction-ref`
*Note: This should be the full path to the file including extension* *Note: This should be the full path to the file including extension*
...@@ -450,7 +452,7 @@ Indicates a run from the current cycle to use when calling ...@@ -450,7 +452,7 @@ Indicates a run from the current cycle to use when calling
This does not have the be the first run of the cycle or This does not have the be the first run of the cycle or
the run number corresponding to the vanadium. However it the run number corresponding to the vanadium. However it
must be in the correct cycle according to the must be in the correct cycle according to the
:ref:`calibration_mapping_pearl-isis-powder-ref`. :ref:`calibration_mapping_pearl_isis-powder-diffraction-ref`.
Example Input: Example Input:
...@@ -719,7 +721,7 @@ This helps remove negative counts where at very low TOF ...@@ -719,7 +721,7 @@ This helps remove negative counts where at very low TOF
the empty counts can exceed the captured neutron counts the empty counts can exceed the captured neutron counts
of the run to process. It also is used of the run to process. It also is used
to crop to the correct TOF window depending on the to crop to the correct TOF window depending on the
value of the :ref:`long_mode_pearl_isis-powder-diffraction-ref` *parameter. value of the :ref:`long_mode_pearl_isis-powder-diffraction-ref` parameter.
*Note: The value passed with the* *Note: The value passed with the*
:ref:`long_mode_pearl_isis-powder-diffraction-ref` *parameter :ref:`long_mode_pearl_isis-powder-diffraction-ref` *parameter
...@@ -743,7 +745,7 @@ Determines the spline coefficient to use after processing ...@@ -743,7 +745,7 @@ Determines the spline coefficient to use after processing
the vanadium in :ref:`create_vanadium_pearl_isis-powder-diffraction-ref` the vanadium in :ref:`create_vanadium_pearl_isis-powder-diffraction-ref`
method. For more details see: :ref:`SplineBackground <algm-SplineBackground>` method. For more details see: :ref:`SplineBackground <algm-SplineBackground>`
*Note that if this value is changed *create_vanadium* *Note that if this value is changed 'create_vanadium'
will need to be called again.* will need to be called again.*
On PEARL this is set to the following: On PEARL this is set to the following:
......
...@@ -318,9 +318,9 @@ method. ...@@ -318,9 +318,9 @@ method.
Accepted values are: **True** or **False** Accepted values are: **True** or **False**
*Note: If this is set to 'True' *Note: If this is set to 'True'*
:ref:`multiple_scattering_polaris_isis-powder-diffraction-ref` :ref:`multiple_scattering_polaris_isis-powder-diffraction-ref`
must be set* *must be set*
Example Input: Example Input:
...@@ -399,7 +399,7 @@ Example Input: ...@@ -399,7 +399,7 @@ Example Input:
input_mode input_mode
^^^^^^^^^^ ^^^^^^^^^^
Indicates how to interpret the parameter Indicates how to interpret the parameter
:ref:`run_number_polaris_isis-powder-diffraction-ref` whilst :ref:`run_number_polaris_isis_powder-diffraction-ref` whilst
calling the :ref:`focus_polaris_isis-powder-diffraction-ref` calling the :ref:`focus_polaris_isis-powder-diffraction-ref`
method. method.
If the input_mode is set to *Summed* it will process If the input_mode is set to *Summed* it will process
...@@ -506,12 +506,12 @@ If multiple runs are specified it will sum these runs ...@@ -506,12 +506,12 @@ If multiple runs are specified it will sum these runs
before subtracting the result. before subtracting the result.
This input uses the same syntax as This input uses the same syntax as
:ref:`run_number_polaris_isis-powder-diffraction-ref`. :ref:`run_number_polaris_isis_powder-diffraction-ref`.
Please visit the above page for more details. Please visit the above page for more details.
*Note: If this parameter is set then to **True** *Note: If this parameter is set to* **True**
:ref:`sample_empty_scale_polaris_isis-powder-diffraction-ref` :ref:`sample_empty_scale_polaris_isis-powder-diffraction-ref`
must also be set. *must also be set.*
Example Input: Example Input:
...@@ -655,7 +655,7 @@ Determines the spline coefficient to use after processing ...@@ -655,7 +655,7 @@ Determines the spline coefficient to use after processing
the vanadium in :ref:`create_vanadium_polaris_isis-powder-diffraction-ref` the vanadium in :ref:`create_vanadium_polaris_isis-powder-diffraction-ref`
method. For more details see :ref:`SplineBackground <algm-SplineBackground>` method. For more details see :ref:`SplineBackground <algm-SplineBackground>`
*Note that if this value is changed *create_vanadium* *Note that if this value is changed 'create_vanadium'
will need to be called again.* will need to be called again.*
On POLARIS this is set to the following: On POLARIS this is set to the following:
...@@ -679,7 +679,7 @@ to produce a spline which better matches the data. ...@@ -679,7 +679,7 @@ to produce a spline which better matches the data.
This parameter is a list of bank cropping values with This parameter is a list of bank cropping values with
one list entry per bank. The values **must** have a larger one list entry per bank. The values **must** have a larger
TOF window than the :ref:`focused_cropping_values_polaris_isis-powder-diffraction-ref` TOF window than the :ref:`focused_cropping_values_polaris_isis-powder-diffraction-ref`
and a smaller window than :ref:`raw_tof_cropping_values_polaris_isis-powder-diffraction-ref`. and a smaller window than :ref:`raw_data_cropping_values_polaris_isis-powder-diffraction-ref`.
On POLARIS this is set to the following: On POLARIS this is set to the following:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment