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

Re #19754 Remove variables from ISIS Powder parameter examples

parent f6289c10
No related merge requests found
...@@ -248,8 +248,7 @@ Example Input: ...@@ -248,8 +248,7 @@ Example Input:
.. code-block:: python .. code-block:: python
calibration_dir = r"C:\path\to\calibration_dir" gem_example = Gem(calibration_directory=r"C:\path\to\calibration_dir", ...)
gem_example = Gem(calibration_directory=calibration_dir, ...)
.. _calibration_mapping_file_gem_isis-powder-diffraction-ref: .. _calibration_mapping_file_gem_isis-powder-diffraction-ref:
...@@ -266,8 +265,7 @@ Example Input: ...@@ -266,8 +265,7 @@ Example Input:
.. code-block:: python .. code-block:: python
# Notice the filename always ends in .yaml # Notice the filename always ends in .yaml
cal_mapping_file = r"C:\path\to\file\calibration_mapping.yaml" gem_example = Gem(calibration_mapping_file=r"C:\path\to\file\calibration_mapping.yaml", ...)
gem_example = Gem(calibration_mapping_file=cal_mapping_file, ...)
.. _config_file_gem_isis-powder-diffraction-ref: .. _config_file_gem_isis-powder-diffraction-ref:
...@@ -286,8 +284,7 @@ Example Input: ...@@ -286,8 +284,7 @@ Example Input:
.. code-block:: python .. code-block:: python
# Notice the filename always ends in .yaml # Notice the filename always ends in .yaml
configuration_file = r"C:\path\to\file\configuration.yaml" gem_example = Gem(config_file=r"C:\path\to\file\configuration.yaml", ...)
gem_example = Gem(config_file=configuration_file, ...)
.. _do_absorb_corrections_gem_isis-powder-diffraction-ref: .. _do_absorb_corrections_gem_isis-powder-diffraction-ref:
...@@ -443,8 +440,7 @@ Example Input: ...@@ -443,8 +440,7 @@ Example Input:
.. code-block:: python .. code-block:: python
output_dir = r"C:\path\to\output_dir" gem_example = Gem(output_directory=r"C:\path\to\output_dir", ...)
gem_example = Gem(output_directory=output_dir, ...)
.. _run_number_gem_isis-powder-diffraction-ref: .. _run_number_gem_isis-powder-diffraction-ref:
......
...@@ -195,8 +195,7 @@ Example Input: ...@@ -195,8 +195,7 @@ Example Input:
.. code-block:: python .. code-block:: python
attenuation_path = r"C:\path\to\attenuation_file.out pearl_example(attenuation_file_path=r"C:\path\to\attenuation_file.out", ...)
pearl_example(attenuation_file_path=attenuation_path, ...)
.. _calibration_directory_pearl_isis-powder-diffraction-ref: .. _calibration_directory_pearl_isis-powder-diffraction-ref:
...@@ -224,8 +223,7 @@ Example Input: ...@@ -224,8 +223,7 @@ Example Input:
.. code-block:: python .. code-block:: python
calibration_dir = r"C:\path\to\calibration_dir" pearl_example = Pearl(calibration_directory=r"C:\path\to\calibration_dir", ...)
pearl_example = Pearl(calibration_directory=calibration_dir, ...)
.. _calibration_mapping_file_pearl_isis-powder-diffraction-ref: .. _calibration_mapping_file_pearl_isis-powder-diffraction-ref:
...@@ -242,8 +240,7 @@ Example Input: ...@@ -242,8 +240,7 @@ Example Input:
.. code-block:: python .. code-block:: python
# Notice the filename always ends in .yaml # Notice the filename always ends in .yaml
cal_mapping_file = r"C:\path\to\file\calibration_mapping.yaml" pearl_example = Pearl(calibration_mapping_file=r"C:\path\to\file\calibration_mapping.yaml", ...)
pearl_example = Pearl(calibration_mapping_file=cal_mapping_file, ...)
.. _config_file_pearl_isis-powder-diffraction-ref: .. _config_file_pearl_isis-powder-diffraction-ref:
...@@ -262,8 +259,7 @@ Example Input: ...@@ -262,8 +259,7 @@ Example Input:
.. code-block:: python .. code-block:: python
# Notice the filename always ends in .yaml # Notice the filename always ends in .yaml
configuration_file = r"C:\path\to\file\configuration.yaml" pearl_example = Pearl(config_file=r"C:\path\to\file\configuration.yaml", ...)
pearl_example = Pearl(config_file=configuration_file, ...)
.. _do_absorb_corrections_pearl_isis-powder-diffraction-ref: .. _do_absorb_corrections_pearl_isis-powder-diffraction-ref:
...@@ -415,8 +411,7 @@ Example Input: ...@@ -415,8 +411,7 @@ Example Input:
.. code-block:: python .. code-block:: python
output_dir = r"C:\path\to\output_dir" pearl_example = Pearl(output_directory=r"C:\path\to\output_dir", ...)
pearl_example = Pearl(output_directory=output_dir, ...)
.. _perform_attenuation_pearl_isis-powder-diffraction-ref: .. _perform_attenuation_pearl_isis-powder-diffraction-ref:
......
...@@ -244,8 +244,7 @@ Example Input: ...@@ -244,8 +244,7 @@ Example Input:
.. code-block:: python .. code-block:: python
calibration_dir = r"C:\path\to\calibration_dir" polaris_example = Polaris(calibration_directory=r"C:\path\to\calibration_dir", ...)
polaris_example = Polaris(calibration_directory=calibration_dir, ...)
.. _calibration_mapping_file_polaris_isis-powder-diffraction-ref: .. _calibration_mapping_file_polaris_isis-powder-diffraction-ref:
...@@ -262,8 +261,7 @@ Example Input: ...@@ -262,8 +261,7 @@ Example Input:
.. code-block:: python .. code-block:: python
# Notice the filename always ends in .yaml # Notice the filename always ends in .yaml
cal_mapping_file = r"C:\path\to\file\calibration_mapping.yaml" polaris_example = Polaris(calibration_mapping_file=r"C:\path\to\file\calibration_mapping.yaml", ...)
polaris_example = Polaris(calibration_mapping_file=cal_mapping_file, ...)
.. _chopper_on_polaris_isis-powder-diffraction-ref: .. _chopper_on_polaris_isis-powder-diffraction-ref:
...@@ -302,8 +300,7 @@ Example Input: ...@@ -302,8 +300,7 @@ Example Input:
.. code-block:: python .. code-block:: python
# Notice the filename always ends in .yaml # Notice the filename always ends in .yaml
configuration_file = r"C:\path\to\file\configuration.yaml" polaris_example = Polaris(config_file=r"C:\path\to\file\configuration.yaml", ...)
polaris_example = Polaris(config_file=configuration_file, ...)
.. _do_absorb_corrections_polaris_isis-powder-diffraction-ref: .. _do_absorb_corrections_polaris_isis-powder-diffraction-ref:
...@@ -458,8 +455,7 @@ Example Input: ...@@ -458,8 +455,7 @@ Example Input:
.. code-block:: python .. code-block:: python
output_dir = r"C:\path\to\output_dir" polaris_example = Polaris(output_directory=r"C:\path\to\output_dir", ...)
polaris_example = Polaris(output_directory=output_dir, ...)
.. _run_number_polaris_isis_powder-diffraction-ref: .. _run_number_polaris_isis_powder-diffraction-ref:
......
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