Commit 8190176a authored by luz.paz's avatar luz.paz
Browse files

docs: typo fixes

Found via `codespell -q 3 -I ../mantid-word-whitelist.txt` where whitelist consists of:  
```
alloced
allws
ang
ans
arithmetics
dum
dur
iff
isnt
ith
lod
mut
nd
originaly
sav
splitted
te
tim
uint
```
parent 35fb59ba
The Mantid documentation is written in [reStructuredText](http://docutils.sourceforge.net/rst.html) and processed using [Sphinx](http://sphinx.pocoo.org/). It uses a custom
boostrap theme for Sphinx and both are required to build the documentation.
bootstrap theme for Sphinx and both are required to build the documentation.
To install Sphinx and the bootstrap theme use `easy_install`:
......
......@@ -40,7 +40,7 @@ spectrum.
The pixel efficiency and incident spectrum correction are NOT CURRENTLY
USED. The absorption correction, trans, depends on both lamda and the
pixel, Which is a fairly expensive calulation when done for each event.
pixel, Which is a fairly expensive calculation when done for each event.
Also see :ref:`algm-LorentzCorrection`
......
......@@ -14,7 +14,7 @@ NeXus file. It is initially for use only at the SNS, as it is needed for
the currently upgrade program. But there is nothing preventing it being
used elsewhere.
The algorithm takes the geometry information in the IDF togther with the
The algorithm takes the geometry information in the IDF together with the
log values in a given NeXus file and calculates the resolved positions
of all the detectors and then writes this into the NeXus file specified.
......
......@@ -45,7 +45,7 @@ All workspaces are converted into wavelength using the appropriate
mode of :ref:`ConvertUnits <algm-ConvertUnits>`. Then
``CanShiftFactor`` is added to wavelength of the ``CanWorkspace``.
Then one of the two following equations is performed
(dependant on the number of correction factors provided):
(dependent on the number of correction factors provided):
.. math:: I_s = \frac{1}{A_{s,sc}} \left( I_{sc}^E - I_c^E K_c \frac{A_{c,sc}}{A_{c,c}} \right)
.. math:: I_s = \frac{1}{A_{s,s}} \left( I_{sc}^E \right) - \frac{1}{A_{c,c}} \left( I_{c}^E \right)
......@@ -134,7 +134,7 @@ Usage
corrections_ws = Load('irs26176_graphite002_cyl_Abs.nxs')
# Interpolate each of the correction factor workspaces to match the
# binning of the smaple
# binning of the sample
# Required to use corrections from the old indirect calculate
# corrections routines
for factor_ws in corrections_ws:
......
......@@ -11,9 +11,9 @@ Description
Authenticate to the remote compute resource. This must be executed
before calling any other remote algorithms. The authentication method
and outcome of ths algorithm is dependent on the particular
and outcome of this algorithm is dependent on the particular
implementation (job manager underlying the algorithm). But typically,
if the authentication is successfull, a cookie is received that is
if the authentication is successful, a cookie is received that is
stored internally and re-used for all subsequent interactions with the
compute resource.
......
......@@ -10,7 +10,7 @@
Description
-----------
**This algorith can only be run on windows due to f2py support and the underlying fortran code**
**This algorithm can only be run on windows due to f2py support and the underlying fortran code**
The model that is being fitted is that of a \delta-function (elastic component) of amplitude A(0)
and Lorentzians of amplitude A(j) and HWHM W(j) where j=1,2,3. The whole function is then convolved
......
......@@ -34,7 +34,7 @@ Restrictions on the input workspace
- X-axis must have the wavelength units.
- Only Histograms can be handled.
- Only :ref:`EventWorkspaces <EventWorkspace>` are suported for the moment.
- Only :ref:`EventWorkspaces <EventWorkspace>` are supported for the moment.
- The input workspace must have an instrument set.
- The input workspace must have a Spectrum axis as a Y-axis.
......
......@@ -36,7 +36,7 @@ expansion coefficients:
where the Chebyshev coefficients :math:`c_{s}(m,n)` up to m + n
:math:`\leqslant` 5 have been tabulated and are stored as an array by the algorithm.
This version of the correction follows the implemenation in [1]_ in that it only calculates for the correction in-plane, unlike [2]_, [3]_ that generalizes the correction to out-of-plane.
This version of the correction follows the implementation in [1]_ in that it only calculates for the correction in-plane, unlike [2]_, [3]_ that generalizes the correction to out-of-plane.
This algorithm calculates and outputs the absorption and/or multiple scattering correction workspaces to be applied to the InputWorkspace. Thus, there are, at most, two workspaces in the OutputWorkspaceBaseName group workspace. This allows for flexibility of applying either correction to a workspace without having to apply both (as is the case with :ref:`algm-CarpenterSampleCorrection`). For the case where both corrections are calculated, the output will be the following:
......@@ -94,7 +94,7 @@ To reproduce what :ref:`algm-CarpenterSampleCorrection` does, you can calculate
# Apply absorption correction to workspace
ws_abs_corrected = Divide(ws, absCorr)
# Apply multple scattering correction to workspace
# Apply multiple scattering correction to workspace
ws_ms_corrected = Minus(ws, msCorr)
# Apply both corrections
......@@ -139,7 +139,7 @@ Output:
# Apply absorption correction to workspace
ws_abs_corrected = Divide(ws, absCorr)
# Apply multple scattering correction to workspace
# Apply multiple scattering correction to workspace
ws_ms_corrected = Minus(ws, msCorr)
# Apply both corrections
......
......@@ -25,7 +25,7 @@ If no minimum/maximum are set for DeltaE, these are chosen to be +/-Ei.
If not specified, minimum/maximum for the Q dimensions are calculated based on the instrument geometry, incident energy,
minimum/maximum for DeltaE, and lattice parameters.
The algorithm calculates detector trajectories in the reciprocal space and sets to 1 the coresponding points in the output workspace.
The algorithm calculates detector trajectories in the reciprocal space and sets to 1 the corresponding points in the output workspace.
All other points are 0.
Usage
......
......@@ -36,7 +36,7 @@ expansion coefficients:
where the Chebyshev coefficients :math:`c_{s}(m,n)` up to m + n
:math:`\leqslant` 5 have been tabulated and are stored as an array by the algorithm.
This version of the correction follows the implemenation in [1]_ in that it only calculates for the correction in-plane, unlike [2]_, [3]_ that generalizes the correction to out-of-plane.
This version of the correction follows the implementation in [1]_ in that it only calculates for the correction in-plane, unlike [2]_, [3]_ that generalizes the correction to out-of-plane.
This algorithm calls :ref:`algm-CalculateCarpenterSampleCorrection` to calculate both absorption and multiple scattering corrections and then applies both to the sample workspace.
......
......@@ -24,7 +24,7 @@ Usage
The code iteslef works but disabled from doc tests as takes too long to complete. User should provide its own
event nexus file instead of **TOPAZ_3132_event.nxs** used within this example. The original **TOPAZ_3132_event.nxs**
file is availible in `Mantid system tests repository <https://github.com/mantidproject/systemtests/tree/master/Data/TOPAZ_3132_event.nxs>`_.
file is available in `Mantid system tests repository <https://github.com/mantidproject/systemtests/tree/master/Data/TOPAZ_3132_event.nxs>`_.
The example shows how applying centroid peaks changes the peak posisions previously calculated by
FindPeaksMD algorithm.
......
......@@ -15,7 +15,7 @@ alters the logs and in case of an :ref:`EventWorkspace <EventWorkspace>` the neu
The time offset can be specified in one of the two following ways:
* A time offset in seconds: In this case all time stamps in the workspace are shifted by the specified amount. A positive entry creates a shift into the future and a negative one creates a shift into the past relative to the original time.
* An ISO8601 time stamp (YYYY-MM-DDTHH:MM:SS, eg 2003-11-30T03:23:54). The logs need to contain a proton_charge time series property for this shift to work. The first time entry of the proton_charge time series is used as a reference time stamp and all times will be shifted according to the differnce between this time stamp and the newly specified value.
* An ISO8601 time stamp (YYYY-MM-DDTHH:MM:SS, eg 2003-11-30T03:23:54). The logs need to contain a proton_charge time series property for this shift to work. The first time entry of the proton_charge time series is used as a reference time stamp and all times will be shifted according to the difference between this time stamp and the newly specified value.
Only one of the two ways of shifting the time can be specified.
......
......@@ -31,7 +31,7 @@ For example: looking at Figure 1 which shows an input workspace covering
100000 microseconds, we can see that the first frame covers forty
thousand, and the other three cover twenty thousand each.
In order for Mantid to determine this programatically, it integrates
In order for Mantid to determine this programmatically, it integrates
over a range (defined by IntegrationRangeLower and
IntegrationRangeUpper) for each "chop" of the data. If the relative
values for this integration fall within certain bounds, then the chop is
......@@ -63,7 +63,7 @@ Usage
result = ChopData(ws, NChops=2, Step=time_diff/2)
print("The time range of the original workspace was {:.0f}.".format(time_diff))
print("The number of bins in the orginal workspace was {}.".format(ws.blocksize()))
print("The number of bins in the original workspace was {}.".format(ws.blocksize()))
print("The number of bins in the 1st chop is {}.".format(result[0][0].blocksize()))
print("The number of bins in the 2nd chop is {}.".format(result[0][1].blocksize()))
......@@ -72,7 +72,7 @@ Output:
.. testoutput:: Ex
The time range of the original workspace was 19800.
The number of bins in the orginal workspace was 100.
The number of bins in the original workspace was 100.
The number of bins in the 1st chop is 48.
The number of bins in the 2nd chop is 48.
......
......@@ -16,7 +16,7 @@ in the form of <prefix>_<sha1>.nxs or <sha1>.nxs.
This algorithm delete all such files from the default
cache directory or the user-defined cache directory, if supplied.
The name matching is done using regex (40 charaters of numbers plus
The name matching is done using regex (40 characters of numbers plus
a-f letters).
Therefore if a user created a file in the designated directory
that happens to have the same pattern, it will be deleted.
......
......@@ -43,7 +43,7 @@ Usage
print("Clearing all parameters")
ClearInstrumentParameters(ws)
#Check the parmaeters have been cleared correctly
#Check the parameters have been cleared correctly
#Obtain instrument and banks again, to make sure they contain the updated parameters
instrument = ws.getInstrument()
bank1 = instrument.getComponentByName("bank1")
......
......@@ -19,7 +19,7 @@ Inputs
The inputs required by algorithm *ConvertHB3AExperimentInfo* are the experiment number, scan numbers
and selected Pt. numbers.
By these parameters, the algorithm can determine the names of the data files and generate a list of
detectors for downstream algorithm to create virutal instrument.
detectors for downstream algorithm to create virtual instrument.
OutputWorkspaces
......
......@@ -14,7 +14,7 @@ This simple algorithm just adds a comment record to the history of a workspace a
It does not change the data within a workspace in any way.
When outputing the histroy to Python this comment will be rendered as a python comment.
When outputting the history to Python this comment will be rendered as a python comment.
Usage
......
......@@ -31,7 +31,7 @@ Algorithm creates a workspace with detector sensitivity correction coefficients
:math:`S_i = \sum_{x = x_C - 3\,\mathrm{fwhm}}^{x_C + 3\,\mathrm{fwhm}} Y_i(x)`
where :math:`x_C` is the peak centre position and :math:`Y_i(x)` is the coresponding to :math:`x` :math:`Y` value for i-th detector.
where :math:`x_C` is the peak centre position and :math:`Y_i(x)` is the corresponding to :math:`x` :math:`Y` value for i-th detector.
3. Finally, the correction coefficients :math:`K_i` are calculated as
......
......@@ -21,7 +21,7 @@ in this patched pixel's tube.
Usage
-----
This is a part of the EQSANS workflow algorithm and is not intended to be executed seperately.
This is a part of the EQSANS workflow algorithm and is not intended to be executed separately.
.. categories::
......
......@@ -10,7 +10,7 @@
Description
-----------
This algorithm joins the input workspaces into a single one by concatenating their spectra. The concatenation is done in the same order as in the input workspaces list. Consider using :ref:`SortXAxis <algm-SortXAxis>` afterwards, if necessary. The instrument and the units are copied from the first workspace. The sample logs are also copied from the first input, but the behaviour can be controlled by the instrument parameter file (IPF), as described in :ref:`MergeRuns <algm-MergeRuns>`. Furthermore, that behaviour can be overriden by providing input to the relevant optional properties of the algorithm. This algorithm joins Dx values, if present.
This algorithm joins the input workspaces into a single one by concatenating their spectra. The concatenation is done in the same order as in the input workspaces list. Consider using :ref:`SortXAxis <algm-SortXAxis>` afterwards, if necessary. The instrument and the units are copied from the first workspace. The sample logs are also copied from the first input, but the behaviour can be controlled by the instrument parameter file (IPF), as described in :ref:`MergeRuns <algm-MergeRuns>`. Furthermore, that behaviour can be overridden by providing input to the relevant optional properties of the algorithm. This algorithm joins Dx values, if present.
InputWorkspaces
---------------
......@@ -24,7 +24,7 @@ This can be a mixed list of workspaces and workspace groups on AnalysisDataServi
SampleLogAsXAxis
----------------
If specified, this log values will constitute the x-axis of the resulting workspace. The log must exist in all the input workspaces and must be numeric (int or double), in which case the input workspaces must contain single bin only, or numeric time series, in which case the lenght of the series must match the number of points.
If specified, this log values will constitute the x-axis of the resulting workspace. The log must exist in all the input workspaces and must be numeric (int or double), in which case the input workspaces must contain single bin only, or numeric time series, in which case the length of the series must match the number of points.
ConjoinX Operation
------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment