Changeset 12944


Ignore:
Timestamp:
08/08/12 11:48:34 (13 years ago)
Author:
jschierm
Message:

CHG: Made python docstrings have consistent indentation.

Location:
issm/trunk-jpl/src/m
Files:
27 edited

Legend:

Unmodified
Added
Removed

  • issm/trunk-jpl/src/m/classes/clusters/generic.py

    r12844 r12944  
    1414        GENERIC cluster class definition
    1515 
    16             Usage:
    17                cluster=generic('name','astrid','np',3);
    18                cluster=generic('name',oshostname(),'np',3,'login','username');
     16           Usage:
     17              cluster=generic('name','astrid','np',3);
     18              cluster=generic('name',oshostname(),'np',3,'login','username');
    1919        """
    2020

  • issm/trunk-jpl/src/m/classes/pairoptions.py

    r12827 r12944  
    55        PAIROPTIONS class definition
    66 
    7             Usage:
    8                pairoptions=pairoptions();
    9                pairoptions=pairoptions('module',true,'solver',false);
     7           Usage:
     8              pairoptions=pairoptions();
     9              pairoptions=pairoptions('module',true,'solver',false);
    1010        """
    1111

  • issm/trunk-jpl/src/m/model/AnalysisConfiguration.py

    r12889 r12944  
    55        ANALYSISCONFIGURATION - return type of analyses, number of analyses
    66
    7             Usage:
    8                [analyses, numanalyses]=AnalysisConfiguration(solutiontype);
     7           Usage:
     8              [analyses, numanalyses]=AnalysisConfiguration(solutiontype);
    99        """
    1010

  • issm/trunk-jpl/src/m/model/MatlabProcessPatch.py

    r12827 r12944  
    33        PROCESSPATCH - create a structure from a patch
    44 
    5             Usage:
    6                Result=ProcessPatch(Result);
     5           Usage:
     6              Result=ProcessPatch(Result);
    77        """
    88

  • issm/trunk-jpl/src/m/model/WriteData.py

    r12943 r12944  
    88        WRITEDATA - write model field in binary file
    99 
    10             Usage:
    11                WriteData(fid,varargin)
     10           Usage:
     11              WriteData(fid,varargin)
    1212        """
    1313

  • issm/trunk-jpl/src/m/model/addnote.py

    r12856 r12944  
    22        """
    33        ADDNOTE - add a note to the existing model notes field
    4          
    5             Usage:
    6                md=addnote(md,string);
    7          
    8             Example:
    9                md=addnote(md,'Pine Island, Geometry of 2007');
     4
     5           Usage:
     6              md=addnote(md,string);
     7
     8           Example:
     9              md=addnote(md,'Pine Island, Geometry of 2007');
    1010        """
    1111

  • issm/trunk-jpl/src/m/model/ismodelselfconsistent.py

    r12943 r12944  
    55        ISMODELSELFCONSISTENT - check that model forms a closed form solvable problem.
    66
    7             Usage:
    8                ismodelselfconsistent(md),
     7           Usage:
     8              ismodelselfconsistent(md),
    99        """
    1010

  • issm/trunk-jpl/src/m/model/loadresultsfromcluster.py

    r12827 r12944  
    88        LOADRESULTSFROMCLUSTER - load results of solution sequence from cluster
    99 
    10             Usage:
    11                md=loadresultsfromcluster(md,runtimename);
     10           Usage:
     11              md=loadresultsfromcluster(md,runtimename);
    1212        """
    1313

  • issm/trunk-jpl/src/m/model/loadresultsfromdisk.py

    r12827 r12944  
    55        LOADRESULTSFROMDISK - load results of solution sequence from disk file "filename"           
    66 
    7             Usage:
    8                md=loadresultsfromdisk(md=False,filename=False);
     7           Usage:
     8              md=loadresultsfromdisk(md=False,filename=False);
    99        """
    1010

  • issm/trunk-jpl/src/m/model/marshall.py

    r12943 r12944  
    55        MARSHALL - outputs a compatible binary file from @model md, for certain solution type.
    66
    7             The routine creates a compatible binary file from @model md
    8             This binary file will be used for parallel runs in JPL-package
     7           The routine creates a compatible binary file from @model md
     8           This binary file will be used for parallel runs in JPL-package
    99
    10             Usage:
    11                marshall(md)
     10           Usage:
     11              marshall(md)
    1212        """
    1313

  • issm/trunk-jpl/src/m/model/parameterization/parameterize.py

    r12874 r12944  
    66        """
    77        PARAMETERIZE - parameterize a model
    8          
    9             from a parameter python file, start filling in all the model fields that were not
    10             filled in by the mesh.py and mask.py model methods.
    11             Warning: the parameter file must be able to be run in Python
    12          
    13             Usage:
    14                md=parameterize(md,parametername)
    15          
    16             Example:
    17                md=parameterize(md,'Square.par');
     8
     9           from a parameter python file, start filling in all the model fields that were not
     10           filled in by the mesh.py and mask.py model methods.
     11           Warning: the parameter file must be able to be run in Python
     12
     13           Usage:
     14              md=parameterize(md,parametername)
     15
     16           Example:
     17              md=parameterize(md,'Square.par');
    1818        """
    1919

  • issm/trunk-jpl/src/m/model/parseresultsfromdisk.py

    r12733 r12944  
    77        """
    88        PARSERESULTSFROMDISK - ...
    9          
    10             Usage:
    11                results=parseresultsfromdisk(filename,iosplit)
     9
     10           Usage:
     11              results=parseresultsfromdisk(filename,iosplit)
    1212        """
    1313

  • issm/trunk-jpl/src/m/model/petscversion.py

    r12827 r12944  
    77        PETSCVERSION - recover petsc version number, inside config.h file
    88 
    9             Usage:
    10                 PETSC_VERSION=petscversion();
     9           Usage:
     10              PETSC_VERSION=petscversion();
    1111        """
    1212

  • issm/trunk-jpl/src/m/model/process_solve_options.py

    r12889 r12944  
    66        DEFAULT_SOLVE_OPTIONS - set up default options for solve phase
    77 
    8             Usage:
    9                options=process_solve_options(options)
     8           Usage:
     9              options=process_solve_options(options)
    1010 
    11             See also: SOLVE
     11           See also: SOLVE
    1212        """
    1313

  • issm/trunk-jpl/src/m/model/recover_areas.py

    r12888 r12944  
    66        RECOVER_AREAS - flag the element depending on the physical model that is assigned to them
    77
    8             This routine is called by setelementstype, do not use
     8           This routine is called by setelementstype, do not use
    99
    10             Usage:
    11                [hutterflag macayealflag pattynflag stokesflag filltype]=recover_areas(md,varargin);
     10           Usage:
     11              [hutterflag macayealflag pattynflag stokesflag filltype]=recover_areas(md,varargin);
    1212        """
    1313

  • issm/trunk-jpl/src/m/model/setflowequation.py

    r12888 r12944  
    99        SETELEMENTSTYPE - associate a solution type to each element
    1010
    11             This routine works like plotmodel: it works with an even number of inputs
    12             'hutter','macayeal','pattyn','stokes' and 'fill' are the possible options
    13             that must be followed by the corresponding exp file or flags list
    14             It can either be a domain file (argus type, .exp extension), or an array of element flags.
    15             If user wants every element outside the domain to be
    16             setflowequationd, add '~' to the name of the domain file (ex: '~Pattyn.exp');
    17             an empty string '' will be considered as an empty domain
    18             a string 'all' will be considered as the entire domain
    19             You can specify the type of coupling, 'penalties' or 'tiling', to use with the input 'coupling'
    20 
    21             Usage:
    22                md=setflowequation(md,varargin)
    23 
    24             Example:
    25                md=setflowequation(md,'pattyn','Pattyn.exp','macayeal',md.mask.elementonfloatingice,'fill','hutter');
    26                md=setflowequation(md,'pattyn','Pattyn.exp',fill','hutter','coupling','tiling');
     11           This routine works like plotmodel: it works with an even number of inputs
     12           'hutter','macayeal','pattyn','stokes' and 'fill' are the possible options
     13           that must be followed by the corresponding exp file or flags list
     14           It can either be a domain file (argus type, .exp extension), or an array of element flags.
     15           If user wants every element outside the domain to be
     16           setflowequationd, add '~' to the name of the domain file (ex: '~Pattyn.exp');
     17           an empty string '' will be considered as an empty domain
     18           a string 'all' will be considered as the entire domain
     19           You can specify the type of coupling, 'penalties' or 'tiling', to use with the input 'coupling'
     20
     21           Usage:
     22              md=setflowequation(md,varargin)
     23
     24           Example:
     25              md=setflowequation(md,'pattyn','Pattyn.exp','macayeal',md.mask.elementonfloatingice,'fill','hutter');
     26              md=setflowequation(md,'pattyn','Pattyn.exp',fill','hutter','coupling','tiling');
    2727        """
    2828

  • issm/trunk-jpl/src/m/model/solve.py

    r12889 r12944  
    1111        SOLVE - apply solution sequence for this model
    1212 
    13             Usage:
    14                md=solve(md,solutionenum,varargin)
    15                where varargin is a list of paired arguments of string OR enums
     13           Usage:
     14              md=solve(md,solutionenum,varargin)
     15              where varargin is a list of paired arguments of string OR enums
    1616 
    17             solution types available comprise:
    18                         - DiagnosticSolutionEnum
    19                         - PrognosticSolutionEnum
    20                         - ThermalSolutionEnum
    21                         - SteadystateSolutionEnum
    22                         - TransientSolutionEnum...
    23                         - BalancethicknessSolutionEnum
    24                         - BedSlopeSolutionEnum
    25                         - SurfaceSlopeSolutionEnum
    26                         - HydrologySolutionEnum
    27                         - FlaimSolutionEnum
     17           solution types available comprise:
     18                  - DiagnosticSolutionEnum
     19                  - PrognosticSolutionEnum
     20                  - ThermalSolutionEnum
     21                  - SteadystateSolutionEnum
     22                  - TransientSolutionEnum...
     23                  - BalancethicknessSolutionEnum
     24                  - BedSlopeSolutionEnum
     25                  - SurfaceSlopeSolutionEnum
     26                  - HydrologySolutionEnum
     27                  - FlaimSolutionEnum
    2828 
    2929           extra options:
    30                - loadonly : does not solve. only load results
     30              - loadonly : does not solve. only load results
    3131 
    32             Examples:
    33                md=solve(md,DiagnosticSolutionEnum);
     32           Examples:
     33              md=solve(md,DiagnosticSolutionEnum);
    3434        """
    3535

  • issm/trunk-jpl/src/m/model/waitonlock.py

    r12827 r12944  
    88        WAITONLOCK - wait for a file
    99 
    10             This routine will return when a file named 'filename' is written to disk.
    11             If the time limit given in input is exceeded, return 0
     10           This routine will return when a file named 'filename' is written to disk.
     11           If the time limit given in input is exceeded, return 0
    1212 
    13             Usage:
    14                flag=waitonlock(md,executionpath)
     13           Usage:
     14              flag=waitonlock(md,executionpath)
    1515        """
    1616

  • issm/trunk-jpl/src/m/utils/BC/SetIceShelfBC.py

    r12854 r12944  
    55        """
    66        SETICESHELFBC - Create the boundary conditions for diagnostic and thermal models for a  Ice Shelf with Ice Front
    7          
    8             Neumann BC are used on the ice front (an ANRGUS contour around the ice front
    9             must be given in input)
    10             Dirichlet BC are used elsewhere for diagnostic
    11          
    12             Usage:
    13                md=SetIceShelfBC(md,varargin)
    14          
    15             Example:
    16                md=SetIceShelfBC(md);
    17                md=SetIceShelfBC(md,'Front.exp');
    18          
    19             See also: SETICESHEETBC, SETMARINEICESHEETBC
     7
     8           Neumann BC are used on the ice front (an ANRGUS contour around the ice front
     9           must be given in input)
     10           Dirichlet BC are used elsewhere for diagnostic
     11
     12           Usage:
     13              md=SetIceShelfBC(md,varargin)
     14
     15           Example:
     16              md=SetIceShelfBC(md);
     17              md=SetIceShelfBC(md,'Front.exp');
     18
     19           See also: SETICESHEETBC, SETMARINEICESHEETBC
    2020        """
    2121

  • issm/trunk-jpl/src/m/utils/Cluster/parallelrange.py

    r12827 r12944  
    44        PARALLELRANGE - from a rank, and a number of processors, figure out a range, for parallel tasks.
    55 
    6             Usage:
    7                i1,i2=parallelrange(rank,numprocs,globalsize)
     6           Usage:
     7              i1,i2=parallelrange(rank,numprocs,globalsize)
    88        """
    99

  • issm/trunk-jpl/src/m/utils/Geometry/FlagElements.py

    r12888 r12944  
    99        FLAGELEMENTS - flag the elements in an region
    1010
    11             The region can be given with an exp file, a list of elements.
     11           The region can be given with an exp file, a list of elements.
    1212
    13             Usage:
    14                flag=FlagElements(md,region);
     13           Usage:
     14              flag=FlagElements(md,region);
    1515
    16             Example:
    17                flag=FlagElements(md,'all');
    18                flag=FlagElements(md,'');
    19                flag=FlagElements(md,'Domain.exp');
    20                flag=FlagElements(md,'~Domain.exp');
    21                flag=FlagElements(md,md.mask.elementongroundedice);
     16           Example:
     17              flag=FlagElements(md,'all');
     18              flag=FlagElements(md,'');
     19              flag=FlagElements(md,'Domain.exp');
     20              flag=FlagElements(md,'~Domain.exp');
     21              flag=FlagElements(md,md.mask.elementongroundedice);
    2222        """
    2323

  • issm/trunk-jpl/src/m/utils/OS/ismumps.py

    r12827 r12944  
    77        ISMUMPS - figure out if MUMPS package was compiled with ISSM
    88 
    9             Usage:
    10                 flag=ismumps();
     9           Usage:
     10              flag=ismumps();
    1111        """
    1212

  • issm/trunk-jpl/src/m/utils/OS/ispetsc.py

    r12827 r12944  
    77        ISPETSC - figure out if PETSC package was compiled with ISSM
    88 
    9             Usage:
    10                 flag=ispetsc();
     9           Usage:
     10              flag=ispetsc();
    1111        """
    1212

  • issm/trunk-jpl/src/m/utils/OS/issmscpin.py

    r12827 r12944  
    1010        SCPIN get packages from host, using scp on unix, and pscp on windows
    1111 
    12             usage: scpin(host,packages,path)
    13  
    14  
     12           usage: scpin(host,packages,path)
    1513        """
    1614

  • issm/trunk-jpl/src/m/utils/OS/issmscpout.py

    r12827 r12944  
    1010        SCPOUT send packages to a host, using scp on unix, and pscp on windows
    1111 
    12             usage: scpout(host,path,packages)
    13  
    14  
     12           usage: scpout(host,path,packages)
    1513        """
    1614

  • issm/trunk-jpl/src/m/utils/OS/issmssh.py

    r12827 r12944  
    99        ISSMSSH - wrapper for OS independent ssh command.
    1010 
    11             usage:
    12                issmssh(host,command)
     11           usage:
     12              issmssh(host,command)
    1313        """
    1414

  • issm/trunk-jpl/src/m/utils/Shell/issmdir.py

    r12827 r12944  
    77        ISSMDIR - Get ISSM_DIR environment variable
    88 
    9             Usage:
    10                ISSM_DIR=issmdir()
     9           Usage:
     10              ISSM_DIR=issmdir()
    1111        """
    1212
Note: See TracChangeset for help on using the changeset viewer.