Changeset 6435

Timestamp:

Jul 21, 2016, 6:39:00 PM (8 years ago)

Author:

mmh

Message:

add option to set status and add support for running tools from python

Location:

trunk/lang/python/Rappture

Files:

• __init__.py (modified) (1 diff)
• python_api.rst (modified) (2 diffs)
• pyxml.py (modified) (1 diff)
• raptool.py (added)

trunk/lang/python/Rappture/__init__.py

@@ -10 +10 @@
 import Utils
 import encoding
+from raptool import Tool
 
 # encoding/decoding flags

trunk/lang/python/Rappture/python_api.rst

@@ -257 +257 @@
 
 
+
+----------
+
+RUNNING RAPPTURE TOOLS FROM PYTHON
+----------------------------------
+
+If you want to write a Python program that runs Rappture tools, you can do it with the above API and
+the Rappture Tool class.  For example, to run a published tool named "complam":
+
+.. code-block:: python
+
+    import Rappture
+    io = Rappture.Tool("complam")
+
+    # Set input values for the Complam tool
+    material = io['input.group(tabs).group(Material)']
+    material['number(E1).current'] = E1 / 1e9
+    material['number(E2).current'] = E2 / 1e9
+
+    # run the tool
+    io.run()
+
+    # read the results
+    ex = io['output.number(Ex).current'].value
+    nu = io['output.number(nu).current'].value
+
 REFERENCE
 =========
@@ -272 +298 @@
 -------
 
-- node.close()
-    Writes out the XML.
+- node.close(status=0)
+    Sets the output status field and writes out the XML.
 
 Reading

trunk/lang/python/Rappture/pyxml.py

@@ -79 +79 @@
         return elem.xml()
 
-    def close(self):
+    def close(self, status=0):
+        self.lib.result(status)
         result(self.lib)
+