improved help for automatic documentation and simplified some scripts

This commit is contained in:
Martin Diehl 2015-05-09 13:01:31 +00:00
parent 59e546e3d7
commit 47b8605733
6 changed files with 42 additions and 52 deletions

View File

@ -38,15 +38,13 @@ Add column(s) containing directional stiffness based on given cubic stiffness va
parser.add_option('-c','--stiffness', dest='vector', action='extend', metavar='<string LIST>',
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('-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

View File

@ -92,13 +92,12 @@ parser.add_option('-c','--coordinates', dest='coords', metavar='string',
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 = '<string LIST>',
help = 'feature type (%s) '%(', '.join(map(lambda x:'|'.join(x['names']),features))) )
parser.add_option('-t','--type', dest = 'type', action = 'extend', metavar = '<string LIST>',
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 = [])
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):

View File

@ -19,10 +19,10 @@ 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:])))
help = 'crystal symmetry [cubic] {%s} '%(', '.join(damask.Symmetry.lattices[1:])))
parser.add_option('-e', '--eulers', dest='eulers', metavar='string',
help = 'Euler angles label')
parser.add_option('-d', '--degrees', dest='degrees', action='store_true',
@ -37,7 +37,7 @@ parser.add_option('-c', dest='c', metavar='string',
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])
parser.set_defaults(pole = (0.0,0.0,1.0))
parser.set_defaults(symmetry = 'cubic')
parser.set_defaults(degrees = False)

View File

@ -22,7 +22,7 @@ parser.add_option('-a','--asciitable', dest='asciitable', metavar='string',
parser.add_option('-c','--map', dest='map', metavar='string',
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='<string LIST>',
help='heading of columns containing vector field values')
parser.add_option('-t','--tensor', dest='tensor', action='extend', metavar='<string LIST>',
@ -31,15 +31,12 @@ parser.add_option('-s','--special', dest='special', action='extend', metavar
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 = [])
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...')

View File

@ -33,12 +33,10 @@ parser.add_option('-e','--strain', dest='strain', action='extend', metavar='<str
help='heading(s) of columns containing strain tensors')
parser.add_option('-s','--stress', dest='stress', action='extend', metavar='<string LIST>',
help='heading(s) of columns containing stress tensors')
parser.set_defaults(strain = [])
parser.set_defaults(stress = [])
(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

View File

@ -30,7 +30,7 @@ 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='<string LIST>',
help='heading of columns containing vector field values')
parser.add_option('-t','--tensor', dest='tensor', action='extend', metavar='<string LIST>',
@ -40,14 +40,11 @@ parser.add_option('-s','--special', dest='special', action='extend', metavar
parser.add_option('-d','--dimension', dest='N', type='int', metavar='int',
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