From 47b8605733e0c185d773ab986b861de794149524 Mon Sep 17 00:00:00 2001 From: Martin Diehl Date: Sat, 9 May 2015 13:01:31 +0000 Subject: [PATCH] improved help for automatic documentation and simplified some scripts --- processing/post/addEhkl.py | 12 +++++------- processing/post/addEuclideanDistance.py | 18 +++++++++--------- processing/post/addIPFcolor.py | 22 +++++++++++----------- processing/post/addMapped.py | 19 ++++++++----------- processing/post/addMises.py | 8 +++----- processing/post/addNorm.py | 15 ++++++--------- 6 files changed, 42 insertions(+), 52 deletions(-) diff --git a/processing/post/addEhkl.py b/processing/post/addEhkl.py index 341204e9f..e77b1ce1d 100755 --- a/processing/post/addEhkl.py +++ b/processing/post/addEhkl.py @@ -36,17 +36,15 @@ Add column(s) containing directional stiffness based on given cubic stiffness va """, version = scriptID) -parser.add_option('-c','--stiffness', dest='vector', action='extend', metavar='', - help='heading of column containing C11 (followed by C12, C44) field values') -parser.add_option('-d','--direction', \ - '--hkl', dest='hkl', type='int', nargs=3, metavar='int int int', - help='direction of elastic modulus %default') -parser.set_defaults(vector = []) +parser.add_option('-c','--stiffness', dest='vector', action='extend', metavar='', + help='heading of column containing C11 (followed by C12, C44) field values') +parser.add_option('-d','--direction','--hkl', dest='hkl', type='int', nargs=3, metavar='int int int', + help='direction of elastic modulus [%default]') parser.set_defaults(hkl = (1,1,1)) (options,filenames) = parser.parse_args() -if len(options.vector)== 0: +if options.vector == None: parser.error('no data column specified...') datainfo = { # list of requested labels per datatype diff --git a/processing/post/addEuclideanDistance.py b/processing/post/addEuclideanDistance.py index 96c31c75d..91ca4919c 100755 --- a/processing/post/addEuclideanDistance.py +++ b/processing/post/addEuclideanDistance.py @@ -89,16 +89,15 @@ Add column(s) containing Euclidean distance to grain structural features: bounda """, version = scriptID) parser.add_option('-c','--coordinates', dest='coords', metavar='string', - help='column heading for coordinates [%default]') + help='column heading for coordinates [%default]') parser.add_option('-i','--identifier', dest='id', metavar = 'string', - help='heading of column containing grain identifier [%default]') -parser.add_option('-t','--type', dest = 'type', action = 'extend', type = 'string', metavar = '', - help = 'feature type (%s) '%(', '.join(map(lambda x:'|'.join(x['names']),features))) ) + help='heading of column containing grain identifier [%default]') +parser.add_option('-t','--type', dest = 'type', action = 'extend', metavar = '', + help = 'feature type {%s} '%(', '.join(map(lambda x:'/'.join(x['names']),features))) ) parser.add_option('-n','--neighborhood',dest='neighborhood', choices = neighborhoods.keys(), metavar = 'string', - help = 'type of neighborhood (%s) [neumann]'%(', '.join(neighborhoods.keys()))) + help = 'type of neighborhood [neumann] {%s}'%(', '.join(neighborhoods.keys()))) parser.add_option('-s', '--scale', dest = 'scale', type = 'float', metavar='float', - help = 'voxel size [%default]') -parser.set_defaults(type = []) + help = 'voxel size [%default]') parser.set_defaults(coords = 'ipinitialcoord') parser.set_defaults(id = 'texture') parser.set_defaults(neighborhood = 'neumann') @@ -106,11 +105,12 @@ parser.set_defaults(scale = 1.0) (options,filenames) = parser.parse_args() -if len(options.type) == 0: parser.error('please select a feature type') +if options.type == None: + parser.error('please select a feature type') if not set(options.type).issubset(set(list(itertools.chain(*map(lambda x: x['names'],features))))): parser.error('type must be chosen from (%s)...'%(', '.join(map(lambda x:'|'.join(x['names']),features))) ) if 'biplane' in options.type and 'boundary' in options.type: - parser.error("please select only one alias for 'biplane' and 'boundary'") + parser.error("both aliases 'biplane' and 'boundary' are selected") feature_list = [] for i,feature in enumerate(features): diff --git a/processing/post/addIPFcolor.py b/processing/post/addIPFcolor.py index d82d868b1..7e3f2a584 100755 --- a/processing/post/addIPFcolor.py +++ b/processing/post/addIPFcolor.py @@ -19,25 +19,25 @@ Add RGB color value corresponding to TSL-OIM scheme for inverse pole figures. """, version = scriptID) parser.add_option('-p', '--pole', dest='pole', type='float', nargs=3, metavar='float float float', - help = 'lab frame direction for inverse pole figure %default') + help = 'lab frame direction for inverse pole figure [%default]') parser.add_option('-s', '--symmetry', dest='symmetry', type='choice', - choices=damask.Symmetry.lattices[1:], metavar='string', - help = 'crystal symmetry (%s) [cubic]'%(', '.join(damask.Symmetry.lattices[1:]))) + choices=damask.Symmetry.lattices[1:], metavar='string', + help = 'crystal symmetry [cubic] {%s} '%(', '.join(damask.Symmetry.lattices[1:]))) parser.add_option('-e', '--eulers', dest='eulers', metavar='string', - help = 'Euler angles label') + help = 'Euler angles label') parser.add_option('-d', '--degrees', dest='degrees', action='store_true', - help = 'Euler angles are given in degrees [%default]') + help = 'Euler angles are given in degrees [%default]') parser.add_option('-m', '--matrix', dest='matrix', metavar='string', - help = 'orientation matrix label') + help = 'orientation matrix label') parser.add_option('-a', dest='a', metavar='string', - help = 'crystal frame a vector label') + help = 'crystal frame a vector label') parser.add_option('-b', dest='b', metavar='string', - help = 'crystal frame b vector label') + help = 'crystal frame b vector label') parser.add_option('-c', dest='c', metavar='string', - help = 'crystal frame c vector label') + help = 'crystal frame c vector label') parser.add_option('-q', '--quaternion', dest='quaternion', metavar='string', - help = 'quaternion label') -parser.set_defaults(pole = [0.0,0.0,1.0]) + help = 'quaternion label') +parser.set_defaults(pole = (0.0,0.0,1.0)) parser.set_defaults(symmetry = 'cubic') parser.set_defaults(degrees = False) diff --git a/processing/post/addMapped.py b/processing/post/addMapped.py index bc21201c3..f1215219d 100755 --- a/processing/post/addMapped.py +++ b/processing/post/addMapped.py @@ -18,28 +18,25 @@ Add data in column(s) of second ASCIItable selected from row that is given by th """, version = scriptID) parser.add_option('-a','--asciitable', dest='asciitable', metavar='string', - help='mapped ASCIItable') + help='mapped ASCIItable') parser.add_option('-c','--map', dest='map', metavar='string', - help='heading of column containing row mapping') + help='heading of column containing row mapping') parser.add_option('-o','--offset', dest='offset', type='int', metavar='int', - help='offset between mapped column value and row') + help='offset between mapped column value and row [%default]') parser.add_option('-v','--vector', dest='vector', action='extend', metavar='', - help='heading of columns containing vector field values') + help='heading of columns containing vector field values') parser.add_option('-t','--tensor', dest='tensor', action='extend', metavar='', - help='heading of columns containing tensor field values') + help='heading of columns containing tensor field values') parser.add_option('-s','--special', dest='special', action='extend', metavar='', - help='heading of columns containing field values of special dimension') + help='heading of columns containing field values of special dimension') parser.add_option('-d','--dimension', dest='N', type='int', metavar='int', - help='dimension of special field values [%default]') -parser.set_defaults(vector = []) -parser.set_defaults(tensor = []) -parser.set_defaults(special = []) + help='dimension of special field values [%default]') parser.set_defaults(offset = 0) parser.set_defaults(N = 1) (options,filenames) = parser.parse_args() -if len(options.vector) + len(options.tensor) + len(options.special) == 0: +if (not None) in [options.vector,options.tensor,options.special]: parser.error('no data column specified...') if options.map == None: parser.error('missing mapping column...') diff --git a/processing/post/addMises.py b/processing/post/addMises.py index eab88a320..f42e6e5c9 100755 --- a/processing/post/addMises.py +++ b/processing/post/addMises.py @@ -30,15 +30,13 @@ Add vonMises equivalent values for symmetric part of requested strains and/or st """, version = scriptID) parser.add_option('-e','--strain', dest='strain', action='extend', metavar='', - help='heading(s) of columns containing strain tensors') + help='heading(s) of columns containing strain tensors') parser.add_option('-s','--stress', dest='stress', action='extend', metavar='', - help='heading(s) of columns containing stress tensors') -parser.set_defaults(strain = []) -parser.set_defaults(stress = []) + help='heading(s) of columns containing stress tensors') (options,filenames) = parser.parse_args() -if len(options.strain) + len(options.stress) == 0: +if (not None) in [options.strain,options.stress]: parser.error('no data column specified...') datainfo = { # list of requested labels per datatype diff --git a/processing/post/addNorm.py b/processing/post/addNorm.py index 2b42f2336..ea3228710 100755 --- a/processing/post/addNorm.py +++ b/processing/post/addNorm.py @@ -30,24 +30,21 @@ Add column(s) containing norm of requested column(s) being either vectors or ten normChoices = ['abs','frobenius','max'] parser.add_option('-n','--norm', dest='norm', type='choice', choices=normChoices, metavar='string', - help='type of element-wise p-norm (%s) [frobenius]'%(','.join(map(str,normChoices)))) + help='type of element-wise p-norm [frobenius] {%s}'%(','.join(map(str,normChoices)))) parser.add_option('-v','--vector', dest='vector', action='extend', metavar='', - help='heading of columns containing vector field values') + help='heading of columns containing vector field values') parser.add_option('-t','--tensor', dest='tensor', action='extend', metavar='', - help='heading of columns containing tensor field values') + help='heading of columns containing tensor field values') parser.add_option('-s','--special', dest='special', action='extend', metavar='', - help='heading of columns containing field values of special dimension') + help='heading of columns containing field values of special dimension') parser.add_option('-d','--dimension', dest='N', type='int', metavar='int', - help='dimension of special field values [%default]') + help='dimension of special field values [%default]') parser.set_defaults(norm = 'frobenius') -parser.set_defaults(vector = []) -parser.set_defaults(tensor = []) -parser.set_defaults(special = []) parser.set_defaults(N = 12) (options,filenames) = parser.parse_args() -if len(options.vector) + len(options.tensor) + len(options.special)== 0: +if (not None) in [options.vector,options.tensor,options.special]: parser.error('no data column specified...') datainfo = { # list of requested labels per datatype