Skip to content

Commit

Permalink
Merge pull request #13019 from mantidproject/13017_fix_docs_with_addi…
Browse files Browse the repository at this point in the history
…tional_code_listings

Fix the source links for some indirect algorithms
  • Loading branch information
raquelalvarezbanos committed Jul 6, 2015
2 parents c0b3b5f + 1107c2a commit 510dbb5
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 9 deletions.
2 changes: 2 additions & 0 deletions Code/Mantid/docs/source/algorithms/DensityOfStates-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,5 @@ Output:
.. categories::

.. sourcelink::
:cpp: None
:h: None
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,5 @@ Output:
.. categories::

.. sourcelink::
:cpp: None
:h: None
2 changes: 2 additions & 0 deletions Code/Mantid/docs/source/algorithms/MSDFit-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,5 @@ Output:
.. categories::

.. sourcelink::
:cpp: None
:h: None
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,8 @@
Description
-----------

Source Code
-----------

The source code for the Python Algorithm may be viewed at:
`OSIRISDiffractionReduction.py <https://github.com/mantidproject/mantid/blob/master/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/OSIRISDiffractionReduction.py>`__
Performs a diffraction reduction for OSIRIS using normalisation to a set of
vanadium sample runs.

Usage
-----
Expand All @@ -23,14 +20,14 @@ Usage
.. testcode:: ExOSIRISDiffractionReductionSimple

import os

def createDummyOSIRISWorkspace(name, func, xmin, xmax, bin_width):
"""Creates a workspace that looks something like an OSIRIS diffraction run"""
#create workspace according to function
ws = CreateSampleWorkspace("Histogram", Function="User Defined", UserDefinedFunction=func, XMin=xmin, XMax=xmax, Random=True, BinWidth=bin_width, NumBanks=11, OutputWorkspace=name)
ws = CropWorkspace(ws, StartWorkspaceIndex=0, EndWorkspaceIndex=1009, OutputWorkspace=name)
AddSampleLog(ws, 'gd_prtn_chrg', '30.01270866394043', 'Number')

#load instrument parameters
LoadInstrument(ws, InstrumentName='OSIRIS')
param_file = config['instrumentDefinition.directory'] + 'OSIRIS_diffraction_diffspec_Parameters.xml'
Expand Down
2 changes: 2 additions & 0 deletions Code/Mantid/docs/source/algorithms/ResNorm-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,5 @@ Usage
.. categories::

.. sourcelink::
:cpp: None
:h: None
5 changes: 3 additions & 2 deletions Code/Mantid/docs/source/interfaces/Indirect_Diffraction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,9 @@ IRIS, OSIRIS diffspec, TOSCA & VESUVIO
.. interface:: Diffraction
:widget: pageDSpaceRebin

All other instruments are supported through the :ref:`MSGDiffractionReduction
<algm-MSGDiffractionReduction>` algorithm and share the same set of options:
All other instruments are supported through the
:ref:`ISISIndirectDiffractionReduction <algm-ISISIndirectDiffractionReduction>`
algorithm and share the same set of options:

Sum Files
If selected the raw files will be summed after they are loaded and the
Expand Down

0 comments on commit 510dbb5

Please sign in to comment.