Changeset 12828


Ignore:
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:
3 edited

Legend:

Unmodified
Added
Removed
  • issm/trunk-jpl/test/NightlyRun/IdFromString.py

    r12652 r12828  
    11#! /usr/bin/env python
    2 """
    3 IDFROMSTRING - output ids from a given string
    4  
    5     Usage:
    6        ids=IdFromString(string)
    7  
    8     Examples:
    9        ids=IdFromString('Parallel')
    10        ids=IdFromString('79North')
    11 """
    12 
    132from IdToName import IdToName
    143
    154def IdFromString(string):
     5        """
     6        IDFROMSTRING - output ids from a given string
     7 
     8            Usage:
     9               ids=IdFromString(string)
     10 
     11            Examples:
     12               ids=IdFromString('Parallel')
     13               ids=IdFromString('79North')
     14        """
    1615
    1716        #Check input
  • issm/trunk-jpl/test/NightlyRun/IdToName.py

    r12819 r12828  
    11#! /usr/bin/env python
    2 """
    3 IDTONAME- return name of test
    4  
    5     Usage:
    6        name=IdToName(id)
    7 """
    82
    93def IdToName(id):
     4        """
     5        IDTONAME- return name of test
     6 
     7            Usage:
     8               name=IdToName(id)
     9        """
     10
    1011        idname={
    1112                101 : 'SquareShelfConstrainedDiagM2d',
  • issm/trunk-jpl/test/NightlyRun/runme.py

    r12658 r12828  
    11#! /usr/bin/env python
    2 """
    3 RUNME - test deck for ISSM nightly runs
    4  
    5     In a test deck directory (tests/Vertification/NightlyRun for example)
    6     The following command will launch all the existing tests:
    7     >>> runme()
    8     To run the tests 101 and 102:
    9     >>> runme(id=[101,102])
    10     etc...
    11  
    12     Available options:
    13        'id'            followed by the list of ids requested
    14        'exclude'       ids to be excluded from the test
    15        'benchmark'     'nightly' (nightly run/ daily run)
    16                        'ismip'  : validation of ismip-hom tests
    17                        'eismint': validation of eismint tests
    18                        'thermal': validation of thermal tests
    19                        'mesh'   : validation of mesh tests
    20                        ...
    21        'procedure'     'check' : run the test (default)
    22                        'update': update the archive
    23  
    24     Usage:
    25        md=runme(varargin);
    26  
    27     Examples:
    28        runme()
    29        runme(exclude=101)
    30        md=runme(id=102,procedure='update')
    31 """
    32 
    332import os
    343import glob
     
    398import sys
    409
     10from parallelrange import parallelrange
     11from IdToName import IdToName
     12
    4113def runme(id=None,exclude=None,benchmark='nightly',procedure='check',output='none',rank=1,numprocs=1):
    42 
    43         from parallelrange import parallelrange
    44         from IdToName import IdToName
     14        """
     15        RUNME - test deck for ISSM nightly runs
     16 
     17            In a test deck directory (tests/Vertification/NightlyRun for example)
     18            The following command will launch all the existing tests:
     19            >>> runme()
     20            To run the tests 101 and 102:
     21            >>> runme(id=[101,102])
     22            etc...
     23 
     24            Available options:
     25               'id'            followed by the list of ids requested
     26               'exclude'       ids to be excluded from the test
     27               'benchmark'     'nightly' (nightly run/ daily run)
     28                               'ismip'  : validation of ismip-hom tests
     29                               'eismint': validation of eismint tests
     30                               'thermal': validation of thermal tests
     31                               'mesh'   : validation of mesh tests
     32                               ...
     33               'procedure'     'check' : run the test (default)
     34                               'update': update the archive
     35 
     36            Usage:
     37               md=runme(varargin);
     38 
     39            Examples:
     40               runme()
     41               runme(exclude=101)
     42               md=runme(id=102,procedure='update')
     43        """
    4544
    4645        #Get ISSM_DIR variable
Note: See TracChangeset for help on using the changeset viewer.