Skip to content
Snippets Groups Projects
Commit 5d9bac0c authored by Shahroz Ahmed's avatar Shahroz Ahmed
Browse files

documentation and release note update

refs #16005
parent 08752886
No related branches found
No related tags found
No related merge requests found
...@@ -330,7 +330,7 @@ Fitting ...@@ -330,7 +330,7 @@ Fitting
early stage of definition and implementation. Not all early stage of definition and implementation. Not all
options may be supported and/or consistent at the moment. options may be supported and/or consistent at the moment.
.. warning:: The input workspace must be converted into a focussed file .. warning:: The input workspace must be converted into a focused file
first. The steps to complete this are found here: :ref:`focus-Engineering_Diffraction-ref` first. The steps to complete this are found here: :ref:`focus-Engineering_Diffraction-ref`
The Fitting tab provides a graphical interface which fits an expected The Fitting tab provides a graphical interface which fits an expected
...@@ -344,7 +344,12 @@ To use the Fitting tab, user is required to provide: ...@@ -344,7 +344,12 @@ To use the Fitting tab, user is required to provide:
1. A focused file as Focus Run input by browsing or entering single/multi 1. A focused file as Focus Run input by browsing or entering single/multi
run number run number
2. List of expected peaks which can be either by browsing a (*CSV*) file 2. List of expected peaks which can be either by browsing a (*CSV*) file
or entering within the text-field simply click on the Fit button. or entering within the text-field
3. Next click on the *Fit* button if you would like to fit single focused
file or you can click *Fit All* button which will enable user to
batch-process all the runs and banks when a range of run number is given,
*Fit All* process may also be used when when a single run number is given
or a file is browsed
.. _ExpectedPeaks-Engineering_Diffraction-ref: .. _ExpectedPeaks-Engineering_Diffraction-ref:
...@@ -386,7 +391,7 @@ Output ...@@ -386,7 +391,7 @@ Output
^^^^^^ ^^^^^^
Once the Fit button has been clicked Mantid will process the data. Please wait Once the Fit button has been clicked Mantid will process the data. Please wait
until the Fitting process has completed. Upon completion you should be able to until the Fitting process has completed. Upon completion you should be able to
view on the Fitting tab which will contain: view on the Fitting tab which will contain:
- The focused workspace plotted in the background in gray crosses. - The focused workspace plotted in the background in gray crosses.
...@@ -406,6 +411,10 @@ workspaces window: ...@@ -406,6 +411,10 @@ workspaces window:
3. The *engggui_fitting_single_peaks* workspace with each workspace 3. The *engggui_fitting_single_peaks* workspace with each workspace
index representing individual expected peak. index representing individual expected peak.
During the Fit process, :ref:`SaveDiffFittingAscii <algm-SaveDiffFittingAscii>`
algorithm will be utilised to save *engggui_fitting_fitpeaks_param*
TableWorkspace as a `csv` file.
In the plots, the x or abscissa axis is in d-spacing units, which are In the plots, the x or abscissa axis is in d-spacing units, which are
more convenient for peak fitting than time-of-flight. However the run more convenient for peak fitting than time-of-flight. However the run
files and the focus files are normally stored as time-of-flight files and the focus files are normally stored as time-of-flight
......
...@@ -45,6 +45,12 @@ Engineering Diffraction ...@@ -45,6 +45,12 @@ Engineering Diffraction
- :ref:`SaveDiffFittingAscii <algm-SaveDiffFittingAscii>` an algorithm which saves a TableWorkspace containing - :ref:`SaveDiffFittingAscii <algm-SaveDiffFittingAscii>` an algorithm which saves a TableWorkspace containing
diffraction fitting results as an ASCII file diffraction fitting results as an ASCII file
- New *Fit All* button on the Fitting Tab will enable user to
batch-process all the runs and banks when a range of run number
is given. During the Fit process,
:ref:`SaveDiffFittingAscii <algm-SaveDiffFittingAscii>` algorithm
will be utilised to save *engggui_fitting_fitpeaks_param*
TableWorkspace as a `csv` file.
Powder Diffraction Powder Diffraction
------------------ ------------------
......
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