Wrote documentation

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

@@ -10,37 +10,37 @@
 Description
 -----------
 
-TODO: Enter a full rst-markup description of your algorithm here.
+This is a workflow algorithm that loads an event nexus file in chunks
+and compresses the resulting chunks before summing them. It uses the
+algorithms:
 
+#. :ref:`algm-DetermineChunking`
+#. :ref:`algm-LoadEventNexus`
+#. :ref:`algm-FilterBadPulses`
+#. :ref:`algm-CompressEvents`
+#. :ref:`algm-Plus` to accumulate
 
-Usage
------
-..  Try not to use files in your examples,
-    but if you cannot avoid it then the (small) files must be added to
-    autotestdata\UsageData and the following tag unindented
-    .. include:: ../usagedata-note.txt
 
-**Example - LoadEventAndCompress**
+Workflow
+########
 
-.. testcode:: LoadEventAndCompressExample
+.. diagram:: LoadEventAndCompress-v1_wkflw.dot
 
-   # Create a host workspace
-   ws = CreateWorkspace(DataX=range(0,3), DataY=(0,2))
-   or
-   ws = CreateSampleWorkspace()
 
-   wsOut = LoadEventAndCompress()
+Usage
+-----
+**Example - LoadEventAndCompress**
 
-   # Print the result
-   print "The output workspace has %i spectra" % wsOut.getNumberHistograms()
+The files needed for this example are not present in our standard usage data
+download due to their size.  They can however be downloaded using these links:
+`PG3_9830_event.nxs <https://github.com/mantidproject/systemtests/blob/master/Data/PG3_9830_event.nxs?raw=true>`_.
 
-Output:
 
-.. testoutput:: LoadEventAndCompressExample
+.. code-block:: python
 
-  The output workspace has ?? spectra
+   PG3_9830_event = LoadEventAndCompress(Filename='PG3_9830_event.nxs',
+                                         MaxChunkSize=1.)
 
 .. categories::
 
 .. sourcelink::
-

Code/Mantid/docs/source/diagrams/LoadEventAndCompress-v1_wkflw.dot

+digraph LoadEventAndCompress {
+  label="LoadEventAndCompress Flowchart"
+  $global_style
+
+  subgraph params {
+    $param_style
+    file1 [label="Filename"]
+    file2 [label="Filename"]
+    OutputWorkspace
+    MaxChunkSize
+    FilterBadPulses
+  }
+
+  subgraph algoritms {
+    $algorithm_style
+    loadEventNexus    [label="LoadEventNexus v1"]
+    compressEvents    [label="CompressEvents v1"]
+    determineChunking [label="DetermineChunking v1"]
+    filterBadPulses   [label="FilterBadPulses v1"]
+    plus              [label="Plus v1"]
+  }
+
+  file1                  -> determineChunking
+  MaxChunkSize           -> determineChunking
+  file2                  -> loadEventNexus
+  determineChunking      -> loadEventNexus [label="loop over chunks"]
+
+  loadEventNexus         -> filterBadPulses
+  FilterBadPulses        -> filterBadPulses
+  filterBadPulses        -> compressEvents
+
+  compressEvents         -> plus
+  plus                   -> loadEventNexus [label="accumulate"]
+  plus                   -> OutputWorkspace
+
+}