From 83e430fb15f3842825a92e0a0237a0862e0192a9 Mon Sep 17 00:00:00 2001
From: Samuel Jackson <samuel.jackson@stfc.ac.uk>
Date: Mon, 9 Jun 2014 09:58:34 +0100
Subject: [PATCH] Refs #9584 Add example for SaveNexusProcessed

---
 .../algorithms/SaveNexusProcessed-v1.rst      | 72 +++++++++++++++++++
 1 file changed, 72 insertions(+)

diff --git a/Code/Mantid/docs/source/algorithms/SaveNexusProcessed-v1.rst b/Code/Mantid/docs/source/algorithms/SaveNexusProcessed-v1.rst
index 7a7cfb6462c8..fc8786d4ab0c 100644
--- a/Code/Mantid/docs/source/algorithms/SaveNexusProcessed-v1.rst
+++ b/Code/Mantid/docs/source/algorithms/SaveNexusProcessed-v1.rst
@@ -45,4 +45,76 @@ data. **Warning!** This can be *very* slow, and only gives approx. 40%
 compression because event data is typically denser than histogram data.
 *CompressNexus* is off by default.
 
+Usage
+-----
+**Example - a basic example using SaveNexusProcessed.**
+
+.. testcode:: ExSaveNexusProcessedSimple
+
+    import os
+
+    ws = CreateSampleWorkspace()
+    file_name = "myworkspace.nxs"
+    SaveNexusProcessed(ws, file_name)
+
+    path = os.path.join(config['defaultsave.directory'], file_name)
+    print os.path.isfile(path)
+
+Output:
+
+.. testoutput:: ExSaveNexusProcessedSimple
+
+    True
+
+.. testcleanup:: ExSaveNexusProcessedSimple
+
+    import os
+    def removeFiles(files):
+      for ws in files:
+        try:
+          path = os.path.join(config['defaultsave.directory'], ws)
+          os.remove(path)
+        except:
+          pass
+
+    removeFiles(file_name)
+
+
+**Example - an example using SaveNexusProcessed with additonal options.**
+
+.. testcode:: ExSaveNexusProcessedOptions
+
+    import os
+
+    ws = CreateSampleWorkspace()
+    file_name = "myworkspace.nxs"
+    SaveNexusProcessed(ws, file_name, Title="MyWorkspace", WorkspaceIndexMin=0, WorkspaceIndexMax=9)
+
+    path = os.path.join(config['defaultsave.directory'], file_name)
+    print os.path.isfile(path)
+
+    ws = Load(file_name)
+    print "Saved workspace has %d spectra" % ws.getNumberHistograms()
+    
+Output:
+
+.. testoutput:: ExSaveNexusProcessedOptions
+
+    True
+    Saved workspace has 10 spectra
+
+.. testcleanup:: ExSaveNexusProcessedOptions
+
+    import os
+    def removeFiles(files):
+      for ws in files:
+        try:
+          path = os.path.join(config['defaultsave.directory'], ws)
+          os.remove(path)
+        except:
+          pass
+
+    removeFiles(file_name)
+
+
 .. categories::