Skip to content

Commit

Permalink
Refs #9587 - Docs for RetrieveRunInfo.
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterParker committed Jun 11, 2014
1 parent fb551ad commit b986c2a
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions Code/Mantid/docs/source/algorithms/RetrieveRunInfo-v1.rst
Expand Up @@ -22,6 +22,7 @@ result table.

Output workspace generated by inspecting runs 12218-12229 and having
the default instrument set to TOSCA.

Limitations
-----------

Expand All @@ -30,4 +31,34 @@ log properties are supported.
:ref:`algm-CreateLogPropertyTable` is available to
those users who wish to "brew their own" version of this algorithm.

Usage
-----

**Example - Creating an Information Table For a Single Run**

.. testcode:: ExSingleRun

# The algorithm takes note of your default facililty/instrument.
# You can change these settings in the interface, or change them
# programmatically as follows:
config['default.instrument'] = 'IRS'
config["default.facility"] = "ISIS"

# Get the information for a IRIS runs 21360 and 26173.
info_table = RetrieveRunInfo(Runs="21360,26173")

print "The table contains information about %i runs." % info_table.rowCount()
print "The first has run number %s." % info_table.cell("run_number", 0)
print "The second has run number %s." % info_table.cell("run_number", 1)
print "The title of the second run is \"%s.\"" % info_table.cell("run_title", 1).strip()

Output:

.. testoutput:: ExSingleRun

The table contains information about 2 runs.
The first has run number 21360.
The second has run number 26173.
The title of the second run is "Vanadium cylinder standard PG002."

.. categories::
File renamed without changes.
File renamed without changes.

0 comments on commit b986c2a

Please sign in to comment.