Refs #9583 add rst files for mpi algorithms

mantidproject · Jun 17, 2014 · a5fedd4 · a5fedd4
1 parent 0e5403b
commit a5fedd4
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/Code/Mantid/docs/source/algorithms/BroadcastWorkspace-v1.rst b/Code/Mantid/docs/source/algorithms/BroadcastWorkspace-v1.rst
@@ -0,0 +1,14 @@
+.. algorithm::
+
+.. summary::
+
+.. alias::
+
+.. properties::
+
+Description
+-----------
+
+BroadcastWorkspace is used to copy a workspace from one process to all the others.
+
+.. categories::
diff --git a/Code/Mantid/docs/source/algorithms/GatherWorkspaces-v1.rst b/Code/Mantid/docs/source/algorithms/GatherWorkspaces-v1.rst
@@ -0,0 +1,17 @@
+.. algorithm::
+
+.. summary::
+
+.. alias::
+
+.. properties::
+
+Description
+-----------
+
+It stitches together the input workspaces provided by each of the processes into a single workspace in the root process.
+The spectra in the output workspace will be ordered by the rank of the input processes.
+It is up to the caller to ensure this results in the required ordering.
+Furthermore, there are all sorts of things that ought to be consistent for this algorithm to make sense (e.g. the instrument). The general philosophy, though, is to leave the responsibility for this to the user and only check the vital things (i.e. that the number of bins is consistent).
+
+.. categories::