grond 12.6 KB
Newer Older
Sebastian Heimann's avatar
Sebastian Heimann committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#!/usr/bin/env python

import math
import sys
import logging
from optparse import OptionParser

from pyrocko import util
from pyrocko.gf import Range

import grond

logger = logging.getLogger('main')

km = 1000.


def d2u(d):
    if isinstance(d, dict):
        return dict((k.replace('-', '_'), v) for (k, v) in d.iteritems())
    else:
        return d.replace('-', '_')


subcommand_descriptions = {
    'init': 'print example configuration',
Sebastian Heimann's avatar
Sebastian Heimann committed
27
    'events': 'print available event names for given configuration',
Sebastian Heimann's avatar
Sebastian Heimann committed
28
    'check': 'check data and configuration',
Sebastian Heimann's avatar
Sebastian Heimann committed
29
30
31
32
33
34
35
36
37
    'go': 'run Grond optimization',
    'forward': 'run forward modelling',
    'harvest': 'manually run harvesting',
    'plot': 'plot optimization result',
    'export': 'export results',
}

subcommand_usages = {
    'init': 'init [options]',
Sebastian Heimann's avatar
Sebastian Heimann committed
38
    'events': 'events <configfile>',
39
40
41
42
43
    'check': 'check <configfile> <eventnames> ... [options]',
    'go': 'go <configfile> <eventnames> ... [options]',
    'forward': (
        'forward <rundir> [options]',
        'forward <configfile> <eventnames> ... [options]'),
Sebastian Heimann's avatar
Sebastian Heimann committed
44
45
    'harvest': 'harvest <rundir> [options]',
    'plot': 'plot <plotnames> <rundir> [options]',
Sebastian Heimann's avatar
Sebastian Heimann committed
46
    'export': 'export (best|mean|ensemble|stats) <rundirs> ... [options]',
Sebastian Heimann's avatar
Sebastian Heimann committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
}

subcommands = subcommand_descriptions.keys()

program_name = 'grond'

usage_tdata = d2u(subcommand_descriptions)
usage_tdata['program_name'] = program_name

usage = '''%(program_name)s <subcommand> [options] [--] <arguments> ...

Subcommands:

    init          %(init)s
Sebastian Heimann's avatar
Sebastian Heimann committed
61
    events        %(events)s
Sebastian Heimann's avatar
Sebastian Heimann committed
62
    check         %(check)s
Sebastian Heimann's avatar
Sebastian Heimann committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
    go            %(go)s
    forward       %(forward)s
    harvest       %(harvest)s
    plot          %(plot)s
    export        %(export)s

To get further help and a list of available options for any subcommand run:

    %(program_name)s <subcommand> --help

''' % usage_tdata


def add_common_options(parser):
    parser.add_option(
        '--loglevel',
        action='store',
        dest='loglevel',
        type='choice',
        choices=('critical', 'error', 'warning', 'info', 'debug'),
        default='info',
Sebastian Heimann's avatar
Sebastian Heimann committed
84
85
86
        help='set logger level to '
             '"critical", "error", "warning", "info", or "debug". '
             'Default is "%default".')
Sebastian Heimann's avatar
Sebastian Heimann committed
87
88
89
90
91
92


def process_common_options(options):
    util.setup_logging(program_name, options.loglevel)


93
def cl_parse(command, args, setup=None, details=None):
Sebastian Heimann's avatar
Sebastian Heimann committed
94
95
96
97
98
99
100
101
102
103
    usage = subcommand_usages[command]
    descr = subcommand_descriptions[command]

    if isinstance(usage, basestring):
        usage = [usage]

    susage = '%s %s' % (program_name, usage[0])
    for s in usage[1:]:
        susage += '\n%s%s %s' % (' '*7, program_name, s)

104
105
106
107
108
109
    description = descr[0].upper() + descr[1:] + '.'

    if details:
        description = description + '\n\n%s' % details

    parser = OptionParser(usage=susage, description=description)
Sebastian Heimann's avatar
Sebastian Heimann committed
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

    if setup:
        setup(parser)

    add_common_options(parser)
    (options, args) = parser.parse_args(args)
    process_common_options(options)
    return parser, options, args


def die(message, err=''):
    if err:
        sys.exit('%s: error: %s \n %s' % (program_name, message, err))
    else:
        sys.exit('%s: error: %s' % (program_name, message))


def help_and_die(parser, message):
    parser.print_help(sys.stderr)
    sys.stderr.write('\n')
    die(message)


def command_init(args):

    dataset_config = grond.DatasetConfig(
        stations_path='stations.txt',
        events_path='events.txt',
        waveform_paths=['data'])

    target_configs = [grond.TargetConfig(
        distance_min=10*km,
        distance_max=1000*km,
        channels=['Z', 'R', 'T'],
        interpolation='multilinear',
        store_id='global_2s',
        inner_misfit_config=grond.InnerMisfitConfig(
            fmin=0.01,
            fmax=0.1))]

    s2 = math.sqrt(2.0)

    problem_config = grond.CMTProblemConfig(
        name_template='cmt_%(event_name)s',
        distance_min=2.*km,
        nbootstrap=100,
        mt_type='deviatoric',
        ranges=dict(
            time=Range(0, 10.0, relative='add'),
            north_shift=Range(-16*km, 16*km),
            east_shift=Range(-16*km, 16*km),
            depth=Range(1*km, 11*km),
            magnitude=Range(4.0, 6.0),
            rmnn=Range(-s2, s2),
            rmee=Range(-s2, s2),
            rmdd=Range(-s2, s2),
            rmne=Range(-1.0, 1.0),
            rmnd=Range(-1.0, 1.0),
            rmed=Range(-1.0, 1.0),
            duration=Range(1.0, 15.0)))

    config = grond.Config(
        dataset_config=dataset_config,
        target_configs=target_configs,
        problem_config=problem_config)

    print config


Sebastian Heimann's avatar
Sebastian Heimann committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def command_events(args):
    def setup(parser):
        pass

    parser, options, args = cl_parse('events', args, setup)
    if len(args) != 1:
        help_and_die(parser, 'missing arguments')

    config_path = args[0]
    config = grond.read_config(config_path)

    for event_name in grond.get_event_names(config):
        print event_name


Sebastian Heimann's avatar
Sebastian Heimann committed
194
195
def command_check(args):
    def setup(parser):
196
197
198
199
200
        parser.add_option(
            '--target-ids', dest='target_string_ids', metavar='TARGET_IDS',
            help='process only selected targets. TARGET_IDS is a '
                 'comma-separated list of target IDs. Target IDs have the '
                 'form SUPERGROUP.GROUP.NETWORK.STATION.LOCATION.CHANNEL.')
Sebastian Heimann's avatar
Sebastian Heimann committed
201

Sebastian Heimann's avatar
Sebastian Heimann committed
202
203
        parser.add_option(
            '--plot', dest='show_plot', action='store_true',
204
205
            help='plot sample synthetics and data.')

206
207
208
209
        parser.add_option(
            '--waveforms', dest='show_waveforms', action='store_true',
            help='show raw, restituted, projected, and processed waveforms')

210
211
212
213
214
215
        parser.add_option(
            '--nrandom', dest='n_random_synthetics', metavar='N', type='int',
            default=10,
            help='set number of random synthetics to forward model (default: '
                 '10). If set to zero, create synthetics for the reference '
                 'solution.')
Sebastian Heimann's avatar
Sebastian Heimann committed
216

Sebastian Heimann's avatar
Sebastian Heimann committed
217
    parser, options, args = cl_parse('check', args, setup)
218
219
    if len(args) < 2:
        help_and_die(parser, 'missing arguments')
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
220

Sebastian Heimann's avatar
Sebastian Heimann committed
221
    config_path = args[0]
222
223
    event_names = args[1:]

Sebastian Heimann's avatar
Sebastian Heimann committed
224
225
    config = grond.read_config(config_path)

226
227
228
229
    target_string_ids = None
    if options.target_string_ids:
        target_string_ids = options.target_string_ids.split(',')

Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
230
231
    grond.check(
        config,
232
        event_names=event_names,
Sebastian Heimann's avatar
Sebastian Heimann committed
233
        target_string_ids=target_string_ids,
234
        show_plot=options.show_plot,
235
        show_waveforms=options.show_waveforms,
236
        n_random_synthetics=options.n_random_synthetics)
Sebastian Heimann's avatar
Sebastian Heimann committed
237
238


Sebastian Heimann's avatar
Sebastian Heimann committed
239
240
241
242
243
244
245
246
def command_go(args):
    def setup(parser):
        parser.add_option(
            '--force', dest='force', action='store_true',
            help='overwrite existing run directory')
        parser.add_option(
            '--status', dest='status', default='state',
            help='status output selection (choices: state, matrix)')
Sebastian Heimann's avatar
Sebastian Heimann committed
247
248
249
        parser.add_option(
            '--parallel', dest='nparallel', type='int', default=1,
            help='set number of events to process in parallel')
Sebastian Heimann's avatar
Sebastian Heimann committed
250
251

    parser, options, args = cl_parse('go', args, setup)
252
253
    if len(args) < 2:
        help_and_die(parser, 'missing arguments')
Sebastian Heimann's avatar
Sebastian Heimann committed
254
255

    config_path = args[0]
256
257
    event_names = args[1:]

Sebastian Heimann's avatar
Sebastian Heimann committed
258
259
260
261
262
263
    config = grond.read_config(config_path)
    if options.status == 'quiet':
        status = ()
    else:
        status = tuple(options.status.split(','))

Sebastian Heimann's avatar
Sebastian Heimann committed
264
265
    grond.go(
        config,
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
266
        event_names=event_names,
Sebastian Heimann's avatar
Sebastian Heimann committed
267
268
269
        force=options.force,
        status=status,
        nparallel=options.nparallel)
Sebastian Heimann's avatar
Sebastian Heimann committed
270
271
272


def command_forward(args):
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
273
    def setup(parser):
274
        pass
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
275
276

    parser, options, args = cl_parse('forward', args, setup)
277
278
    if len(args) < 1:
        help_and_die(parser, 'missing arguments')
Sebastian Heimann's avatar
Sebastian Heimann committed
279

280
    event_names = args[1:]
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
281

Sebastian Heimann's avatar
Sebastian Heimann committed
282
283
284
    if not event_names:
        help_and_die(parser, 'no event names given')

285
    run_path = args[0]
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
286
287
288
    grond.forward(
        run_path,
        event_names=event_names)
Sebastian Heimann's avatar
Sebastian Heimann committed
289
290
291
292
293
294
295
296
297
298


def command_harvest(args):
    def setup(parser):
        parser.add_option(
            '--force', dest='force', action='store_true',
            help='overwrite existing harvest directory')
        parser.add_option(
            '--neach', dest='neach', type=int, default=10,
            help='take NEACH best samples from each chain (default: 10)')
Sebastian Heimann's avatar
Sebastian Heimann committed
299
300
        parser.add_option(
            '--weed', dest='weed', type=int, default=0,
301
302
303
304
305
306
307
308
309
310
311
            help='weed out bootstrap samples with bad global performance. '
                 '0: no weeding (default), '
                 '1: only bootstrap chains where all NEACH best samples '
                 'global misfit is less than the global average misfit of all '
                 'NEACH best in all chains plus one standard deviation are '
                 'included in the harvest ensemble, '
                 '2: same as 1 but additionally individual samples are '
                 'removed if their global misfit is greater than the global '
                 'average misfit of all NEACH best in all chains, '
                 '3: harvesting is done on the global chain only, bootstrap '
                 'chains are excluded')
Sebastian Heimann's avatar
Sebastian Heimann committed
312
313
314
315
316
317

    parser, options, args = cl_parse('harvest', args, setup)
    if len(args) != 1:
        help_and_die(parser, 'no rundir')

    run_path, = args
Sebastian Heimann's avatar
Sebastian Heimann committed
318
319
320
321
322
    grond.harvest(
        run_path,
        force=options.force,
        nbest=options.neach,
        weed=options.weed)
Sebastian Heimann's avatar
Sebastian Heimann committed
323
324
325


def command_plot(args):
326
327
328
329
330
331
332
333
334
335
336
337
    from grond import plot

    def setup(parser):
        parser.add_option(
            '--save', dest='save', action='store_true', default=False,
            help='save figures to files')

        parser.add_option(
            '--format', '--formats', dest='formats', default='pdf',
            help='comma-separated list of ouptut formats (default: pdf)')

        parser.add_option(
338
339
            '--dpi', '--dpi', dest='dpi', type=float, default=120.,
            help='DPI setting for raster formats (default=120)')
340
341
342
343
344
345
346
347
348

    plotnames_avail = plot.available_plotnames()

    details = '''Available <plotnames> are: %s, or "all". Multiple plots are
selected by specifying a comma-separated list.''' % (
        ', '.join('"%s"' % x for x in plotnames_avail))

    parser, options, args = cl_parse('plot', args, setup, details)

Sebastian Heimann's avatar
Sebastian Heimann committed
349
350
351
    if len(args) != 2:
        help_and_die(parser, 'two arguments required')

352
353
354
355
356
357
    if args[0] == 'all':
        plotnames = plotnames_avail
    else:
        plotnames = args[0].split(',')

    formats = options.formats.split(',')
Sebastian Heimann's avatar
Sebastian Heimann committed
358
    dirname = args[1]
359
360
361
362
363
364
365
366

    try:
        plot.plot_result(
            dirname, plotnames,
            save=options.save, formats=formats, dpi=options.dpi)

    except grond.GrondError, e:
        die(str(e))
Sebastian Heimann's avatar
Sebastian Heimann committed
367
368
369
370


def command_export(args):

Sebastian Heimann's avatar
Sebastian Heimann committed
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
    def setup(parser):
        parser.add_option(
            '--type', dest='type', metavar='TYPE',
            choices=('event', 'source', 'vector'),
            help='select type of objects to be exported. Choices: '
                 '"event" (default), "source", "vector".')

        parser.add_option(
            '--parameters', dest='parameters', metavar='PLIST',
            help='select parameters to be exported. PLIST is a '
                 'comma-separated list where each entry has the form '
                 '"<parameter>[.<measure>]". Available measures: "best", '
                 '"mean", "std", "minimum", "percentile16", "median", '
                 '"percentile84", "maximum".')

        parser.add_option(
            '--output', dest='filename', metavar='FILE',
            help='write output to FILE')

    parser, options, args = cl_parse('export', args, setup)
    if len(args) < 2:
        help_and_die(parser, 'arguments required')

    what = args[0]

    dirnames = args[1:]

    what_choices = ('best', 'mean', 'ensemble', 'stats')

    if what not in what_choices:
        help_and_die(
            parser,
            'invalid choice: %s (choose from %s)' % (
                repr(what), ', '.join(repr(x) for x in what_choices)))

    if options.parameters:
        pnames = options.parameters.split(',')
Sebastian Heimann's avatar
Sebastian Heimann committed
408
    else:
Sebastian Heimann's avatar
Sebastian Heimann committed
409
410
411
412
413
414
415
416
417
418
419
420
        pnames = None

    try:
        grond.export(
            what,
            dirnames,
            filename=options.filename,
            type=options.type,
            pnames=pnames)

    except grond.GrondError, e:
        die(str(e))
Sebastian Heimann's avatar
Sebastian Heimann committed
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444


if __name__ == '__main__':

    if len(sys.argv) < 2:
        sys.exit('Usage: %s' % usage)

    args = list(sys.argv)
    args.pop(0)
    command = args.pop(0)

    if command in subcommands:
        globals()['command_' + d2u(command)](args)

    elif command in ('--help', '-h', 'help'):
        if command == 'help' and args:
            acommand = args[0]
            if acommand in subcommands:
                globals()['command_' + acommand](['--help'])

        sys.exit('Usage: %s' % usage)

    else:
        die('no such subcommand: %s' % command)