diff --git a/docs/source/interfaces/Engineering_Diffraction.rst b/docs/source/interfaces/Engineering_Diffraction.rst index 5bdb57800e0f141de3342d74e9de7de62808bb4a..b9244c9f8627c4cfc3f800073683a88ff8a55cf0 100644 --- a/docs/source/interfaces/Engineering_Diffraction.rst +++ b/docs/source/interfaces/Engineering_Diffraction.rst @@ -330,7 +330,7 @@ Fitting early stage of definition and implementation. Not all 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` 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: 1. A focused file as Focus Run input by browsing or entering single/multi run number 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: @@ -386,7 +391,7 @@ Output ^^^^^^ 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: - The focused workspace plotted in the background in gray crosses. @@ -406,6 +411,10 @@ workspaces window: 3. The *engggui_fitting_single_peaks* workspace with each workspace 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 more convenient for peak fitting than time-of-flight. However the run files and the focus files are normally stored as time-of-flight diff --git a/docs/source/release/v3.8.0/diffraction.rst b/docs/source/release/v3.8.0/diffraction.rst index c6058e4cd2df42065dbb1f6d5c1b66950b3340e7..12a9c3a87255aff58b04cc7d039b71ebfd3de170 100644 --- a/docs/source/release/v3.8.0/diffraction.rst +++ b/docs/source/release/v3.8.0/diffraction.rst @@ -45,6 +45,12 @@ Engineering Diffraction - :ref:`SaveDiffFittingAscii <algm-SaveDiffFittingAscii>` an algorithm which saves a TableWorkspace containing 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 ------------------