From 968921cf7337d3c044ddec61b871c0282dd70e8d Mon Sep 17 00:00:00 2001
From: Pete Peterson <petersonpf@ornl.gov>
Date: Mon, 12 Oct 2015 11:15:54 -0400
Subject: [PATCH] Adding documentation for PDToPDFgetN
---
docs/source/algorithms/PDToPDFgetN-v1.rst | 32 +++++++++++++++++
docs/source/diagrams/PDToPDFgetN-v1_wkflw.dot | 34 +++++++++++++++++++
2 files changed, 66 insertions(+)
create mode 100644 docs/source/algorithms/PDToPDFgetN-v1.rst
create mode 100644 docs/source/diagrams/PDToPDFgetN-v1_wkflw.dot
diff --git a/docs/source/algorithms/PDToPDFgetN-v1.rst b/docs/source/algorithms/PDToPDFgetN-v1.rst
new file mode 100644
index 00000000000..f37aae644e2
--- /dev/null
+++ b/docs/source/algorithms/PDToPDFgetN-v1.rst
@@ -0,0 +1,32 @@
+.. algorithm::
+
+.. summary::
+
+.. alias::
+
+.. properties::
+
+Description
+-----------
+
+This is a workflow algorithm that creates files suitable as input
+into `PDFgetN <http://pdfgetn.sourceforge.net/>`_.
+
+#. :ref:`algm-PDLoadCharacterizations`
+#. :ref:`algm-LoadEventAndCompress` if ``InputWorkspace`` is not
+ provided
+#. :ref:`algm-PDDetermineCharacterizations` to determine information
+ from the characterization file
+#. :ref:`algm-AlignAndFocusPowder`
+#. :ref:`algm-NormaliseByCurrent`
+#. :ref:`algm-SetUncertainties` (``SetError="sqrt"``)
+#. :ref:`algm-SaveGSS`
+
+Workflow
+########
+
+.. diagram:: PDToPDFgetN-v1_wkflw.dot
+
+.. categories::
+
+.. sourcelink::
diff --git a/docs/source/diagrams/PDToPDFgetN-v1_wkflw.dot b/docs/source/diagrams/PDToPDFgetN-v1_wkflw.dot
new file mode 100644
index 00000000000..23d7d3128f5
--- /dev/null
+++ b/docs/source/diagrams/PDToPDFgetN-v1_wkflw.dot
@@ -0,0 +1,34 @@
+digraph AlignAndFocusPowder {
+ label="AlignAndFocusPowder Flowchart"
+ $global_style
+
+ subgraph params {
+ $param_style
+ InputWorkspace
+ }
+
+ subgraph algoritms {
+ $algorithm_style
+ loadChar [label="PDLoadCharacterizations v1"]
+ loadEvent [label="LoadEventAndCompress v1"]
+ determineChar [label="PDDetermineCharacterizations v1"]
+ alignAndFocus [label="AlignAndFocusPowder v1"]
+ norm [label="NormaliseByCurrent v1"]
+ setUncert [label="SetUncertainties v1"]
+ saveGSS [label="SaveGSS v1"]
+ }
+
+ subgraph decisions {
+ $decision_style
+ }
+
+
+ loadChar -> determineChar
+ loadEvent -> InputWorkspace
+ InputWorkspace -> determineChar
+ InputWorkspace -> alignAndFocus
+ determineChar -> alignAndFocus
+ alignAndFocus -> norm
+ norm -> setUncert
+ setUncert -> saveGSS
+}
--
GitLab