Changeset 12828

Timestamp:

07/30/12 14:44:10 (13 years ago)

Author:

jschierm

Message:

Fixed docstrings so that ipython could use them.

Location:

issm/trunk-jpl/test/NightlyRun

Files:

• IdFromString.py (modified) (1 diff)
• IdToName.py (modified) (1 diff)
• runme.py (modified) (2 diffs)

issm/trunk-jpl/test/NightlyRun/IdFromString.py

@@ -1 +1 @@
 #! /usr/bin/env python
-"""
-IDFROMSTRING - output ids from a given string
- 
-    Usage:
-       ids=IdFromString(string)
- 
-    Examples:
-       ids=IdFromString('Parallel')
-       ids=IdFromString('79North')
-"""
-
 from IdToName import IdToName
 
 def IdFromString(string):
+        """
+        IDFROMSTRING - output ids from a given string
+ 
+            Usage:
+               ids=IdFromString(string)
+ 
+            Examples:
+               ids=IdFromString('Parallel')
+               ids=IdFromString('79North')
+        """
 
         #Check input

issm/trunk-jpl/test/NightlyRun/IdToName.py

@@ -1 +1 @@
 #! /usr/bin/env python
-"""
-IDTONAME- return name of test
- 
-    Usage:
-       name=IdToName(id)
-"""
 
 def IdToName(id):
+        """
+        IDTONAME- return name of test
+ 
+            Usage:
+               name=IdToName(id)
+        """
+
         idname={
                 101 : 'SquareShelfConstrainedDiagM2d',

issm/trunk-jpl/test/NightlyRun/runme.py

@@ -1 +1 @@
 #! /usr/bin/env python
-"""
-RUNME - test deck for ISSM nightly runs
- 
-    In a test deck directory (tests/Vertification/NightlyRun for example)
-    The following command will launch all the existing tests:
-    >>> runme()
-    To run the tests 101 and 102:
-    >>> runme(id=[101,102])
-    etc...
- 
-    Available options:
-       'id'            followed by the list of ids requested
-       'exclude'       ids to be excluded from the test
-       'benchmark'     'nightly' (nightly run/ daily run)
-                       'ismip'  : validation of ismip-hom tests
-                       'eismint': validation of eismint tests
-                       'thermal': validation of thermal tests
-                       'mesh'   : validation of mesh tests
-                       ...
-       'procedure'     'check' : run the test (default)
-                       'update': update the archive
- 
-    Usage:
-       md=runme(varargin);
- 
-    Examples:
-       runme()
-       runme(exclude=101)
-       md=runme(id=102,procedure='update')
-"""
-
 import os
 import glob
@@ -39 +8 @@
 import sys
 
+from parallelrange import parallelrange
+from IdToName import IdToName
+
 def runme(id=None,exclude=None,benchmark='nightly',procedure='check',output='none',rank=1,numprocs=1):
-
-        from parallelrange import parallelrange
-        from IdToName import IdToName
+        """
+        RUNME - test deck for ISSM nightly runs
+ 
+            In a test deck directory (tests/Vertification/NightlyRun for example)
+            The following command will launch all the existing tests:
+            >>> runme()
+            To run the tests 101 and 102:
+            >>> runme(id=[101,102])
+            etc...
+ 
+            Available options:
+               'id'            followed by the list of ids requested
+               'exclude'       ids to be excluded from the test
+               'benchmark'     'nightly' (nightly run/ daily run)
+                               'ismip'  : validation of ismip-hom tests
+                               'eismint': validation of eismint tests
+                               'thermal': validation of thermal tests
+                               'mesh'   : validation of mesh tests
+                               ...
+               'procedure'     'check' : run the test (default)
+                               'update': update the archive
+ 
+            Usage:
+               md=runme(varargin);
+ 
+            Examples:
+               runme()
+               runme(exclude=101)
+               md=runme(id=102,procedure='update')
+        """
 
         #Get ISSM_DIR variable