Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
mantid
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Code review analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
mantidproject
mantid
Commits
eb44047b
Commit
eb44047b
authored
5 years ago
by
Sam Jenkins
Browse files
Options
Downloads
Patches
Plain Diff
updated polaris docs to reflect optional keywords
parent
c87625cc
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/techniques/ISISPowder-Polaris-v1.rst
+10
-17
10 additions, 17 deletions
docs/source/techniques/ISISPowder-Polaris-v1.rst
with
10 additions
and
17 deletions
docs/source/techniques/ISISPowder-Polaris-v1.rst
+
10
−
17
View file @
eb44047b
...
...
@@ -70,19 +70,16 @@ the user enables and will spline the resulting workspace(s) for later focusing.
On POLARIS the following parameters are required when executing *create_vanadium*:
- :ref:`calibration_mapping_file_polaris_isis-powder-diffraction-ref`
- :ref:`mode_polaris_isis-powder-diffraction-ref`
- :ref:`do_absorb_corrections_polaris_isis-powder-diffraction-ref`
- :ref:`first_cycle_run_no_polaris_isis-powder-diffraction-ref`
If :ref:`do_absorb_corrections_polaris_isis-powder-diffraction-ref` is
set to **True** the following parameter is required in addition to the
above:
The following may optionally be set.
- :ref:`mode_polaris_isis-powder-diffraction-ref`
- :ref:`multiple_scattering_polaris_isis-powder-diffraction-ref`
Example
=======
.. code-block:: python
# Notice how the filename ends with .yaml
...
...
@@ -102,20 +99,17 @@ focuses and optionally applies corrections if the user has requested them.
On POLARIS the following parameters are required when executing *focus*:
- :ref:`calibration_mapping_file_polaris_isis-powder-diffraction-ref`
- :ref:`mode_polaris_isis-powder-diffraction-ref`
- :ref:`do_absorb_corrections_polaris_isis-powder-diffraction-ref`
- :ref:`do_van_normalisation_polaris_isis-powder-diffraction-ref`
- :ref:`input_mode_polaris_isis-powder-diffraction-ref`
- :ref:`run_number_polaris_isis_powder-diffraction-ref`
If :ref:`do_absorb_corrections_polaris_isis-powder-diffraction-ref` is
set to **True** the following parameter is required in addition to the
above:
- :ref:`multiple_scattering_polaris_isis-powder-diffraction-ref`
The following parameters may also be optionally set:
- :ref:`mode_polaris_isis-powder-diffraction-ref`
- :ref:`multiple_scattering_polaris_isis-powder-diffraction-ref`
- :ref:`file_ext_polaris_isis-powder-diffraction-ref`
- :ref:`sample_empty_polaris_isis_powder-diffraction-ref`
- :ref:`suffix_polaris_isis-powder-diffraction-ref`
...
...
@@ -300,6 +294,7 @@ Example Input:
mode
^^^^^^^^^^
*optional*
The current chopper mode to use in the
:ref:`create_vanadium_polaris_isis-powder-diffraction-ref`
and :ref:`focus_polaris_isis-powder-diffraction-ref` method.
...
...
@@ -310,6 +305,9 @@ Accepted values are: **PDF** or **Rietveld**
*Note: This parameter is not case sensitive*
If this value is not set, mantid will attempt to deduce it from
the frequency logs.
Example Input:
.. code-block:: python
...
...
@@ -350,10 +348,6 @@ method.
Accepted values are: **True** or **False**
*Note: If this is set to 'True'*
:ref:`multiple_scattering_polaris_isis-powder-diffraction-ref`
*must be set*
Example Input:
.. code-block:: python
...
...
@@ -453,10 +447,9 @@ Example Input:
multiple_scattering
^^^^^^^^^^^^^^^^^^^
*optional*
Indicates whether to account for the effects of multiple scattering
when calculating absorption corrections. If
:ref:`do_absorb_corrections_polaris_isis-powder-diffraction-ref` is
set to **True** this parameter must be set.
when calculating absorption corrections.
Accepted values are: **True** or **False**
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment