Refs #9584 Add example for MuscatData

Code/Mantid/docs/source/algorithms/MuscatData-v1.rst

@@ -20,4 +20,35 @@ References
 
 #. M W Johnson, AERE Report R7682 (1974)
 
+Usage
+-----
+**Example - a basic example using MuscatData.**
+
+.. codeblock::
+
+		def createSampleWorkspace(name, random=False):
+			""" Creates a sample workspace with a single lorentzian that looks like IRIS data"""
+			import os
+			function = "name=Lorentzian,Amplitude=8,PeakCentre=5,FWHM=0.7"
+			ws = CreateSampleWorkspace("Histogram", Function="User Defined", UserDefinedFunction=function, XUnit="DeltaE", Random=True, XMin=0, XMax=10, BinWidth=0.01)
+			ws = CropWorkspace(ws, StartWorkspaceIndex=0, EndWorkspaceIndex=9)
+			ws = ScaleX(ws, -5, "Add")
+			ws = ScaleX(ws, 0.1, "Multiply")
+
+			#load instrument and instrument parameters
+			LoadInstrument(ws, InstrumentName='IRIS')
+			path = os.path.join(config['instrumentDefinition.directory'], 'IRIS_graphite_002_Parameters.xml')
+			LoadParameterFile(ws, Filename=path)
+			ws = RenameWorkspace(ws, OutputWorkspace=name)
+			return ws
+
+
+		ws = createSampleWorkspace("irs26173_graphite002_red", random=True)
+		sqw = SofQW(ws, QAxisBinning='2,1,10', Emode='Indirect', OutputWorkspace="irs26173_graphite002_sqw")
+		SaveNexus(ws, "irs26173_graphite002_red.nxs")
+		SaveNexus(sqw, "irs26173_graphite002_sqw.nxs")
+
+		MuscatData(SamNumber='26173', SqwInput='26173', Thick='0.5', Width='0.5', Instrument='irs') 
+
+
 .. categories::