grond 15.2 KB
Newer Older
Sebastian Heimann's avatar
Sebastian Heimann committed
1
2
3
4
5
#!/usr/bin/env python

import math
import sys
import logging
6
import os
Marius Isken's avatar
Marius Isken committed
7
import os.path as op
Sebastian Heimann's avatar
Sebastian Heimann committed
8
9
10
11
12
13
14
15
from optparse import OptionParser

from pyrocko import util
from pyrocko.gf import Range

import grond

logger = logging.getLogger('main')
16
km = 1e3
Sebastian Heimann's avatar
Sebastian Heimann committed
17
18
19
20
21
22
23
24
25
26
27


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
28
    'events': 'print available event names for given configuration',
Sebastian Heimann's avatar
Sebastian Heimann committed
29
    'check': 'check data and configuration',
Sebastian Heimann's avatar
Sebastian Heimann committed
30
31
32
33
34
35
36
37
38
    '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
39
    'events': 'events <configfile>',
40
41
42
43
44
    '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
45
46
    'harvest': 'harvest <rundir> [options]',
    'plot': 'plot <plotnames> <rundir> [options]',
Sebastian Heimann's avatar
Sebastian Heimann committed
47
    'export': 'export (best|mean|ensemble|stats) <rundirs> ... [options]',
Sebastian Heimann's avatar
Sebastian Heimann committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
}

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
62
    events        %(events)s
Sebastian Heimann's avatar
Sebastian Heimann committed
63
    check         %(check)s
Sebastian Heimann's avatar
Sebastian Heimann committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
    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
85
86
87
        help='set logger level to '
             '"critical", "error", "warning", "info", or "debug". '
             'Default is "%default".')
Sebastian Heimann's avatar
Sebastian Heimann committed
88
89
90
91
92
93


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


94
def cl_parse(command, args, setup=None, details=None):
Sebastian Heimann's avatar
Sebastian Heimann committed
95
96
97
98
99
100
101
102
103
104
    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)

105
106
107
108
109
110
    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
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

    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):

Marius Isken's avatar
Marius Isken committed
136
137
138
    def setup(parser):
        parser.add_option(
            '--waveform', dest='waveform', action='store_true', default=True,
139
140
            help='Create an example configuration for waveform inversion. '
                 '(default)')
Marius Isken's avatar
Marius Isken committed
141
142
        parser.add_option(
            '--static', dest='static', action='store_true',
143
144
            help='Create an example configuration for static displacements'
                 ' using kite scene containers.')
Marius Isken's avatar
Marius Isken committed
145
146
147

    parser, options, args = cl_parse('init', args, setup)

148
149
    dir_struct = ['gf_store']

Marius Isken's avatar
Marius Isken committed
150
    if options.waveform and not options.static:
151
        dir_struct += ['data']
Marius Isken's avatar
Marius Isken committed
152
153
154
155
156
157
        dataset_config = grond.DatasetConfig(
            stations_path='stations.txt',
            events_path='events.txt',
            waveform_paths=['data'])

        target_configs = [grond.TargetConfig(
158
159
            super_group='time_domain',
            group='all',
Marius Isken's avatar
Marius Isken committed
160
161
162
163
            distance_min=10*km,
            distance_max=1000*km,
            channels=['Z', 'R', 'T'],
            interpolation='multilinear',
164
            store_id='gf_store',
Marius Isken's avatar
Marius Isken committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
            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))
            )

    elif options.static:
191
        dir_struct += ['scenes']
Marius Isken's avatar
Marius Isken committed
192
        dataset_config = grond.DatasetConfig(
193
194
            events_path='events.txt',
            kite_scene_paths=['scenes'],
Marius Isken's avatar
Marius Isken committed
195
196
197
            )

        target_configs = [grond.TargetConfig(
198
199
            super_group='insar_target',
            group='all',
Marius Isken's avatar
Marius Isken committed
200
            interpolation='multilinear',
201
            store_id='gf_store',
Marius Isken's avatar
Marius Isken committed
202
            inner_satellite_misfit_config=grond.InnerSatelliteMisfitConfig(
203
                use_weight_focal=False))]
Marius Isken's avatar
Marius Isken committed
204
205
206
207
208
209
210
211
212
213
214
215
216
217

        problem_config = grond.RectangularProblemConfig(
            name_template='rect_source',
            ranges=dict(
                north_shift=Range(-20*km, 20*km),
                east_shift=Range(-20*km, 20*km),
                depth=Range(0*km, 10*km),
                length=Range(20*km, 40*km),
                width=Range(5*km, 12*km),
                dip=Range(20, 70),
                strike=Range(0, 180),
                rake=Range(0, 90),
                slip=Range(1, 3))
            )
Sebastian Heimann's avatar
Sebastian Heimann committed
218

219
220
221
    engine_config = grond.EngineConfig(
        gf_store_superdirs=['.'])

Sebastian Heimann's avatar
Sebastian Heimann committed
222
    config = grond.Config(
223
        rundir_template=op.join(op.abspath(op.curdir), 'rundir'),
Sebastian Heimann's avatar
Sebastian Heimann committed
224
225
        dataset_config=dataset_config,
        target_configs=target_configs,
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
        problem_config=problem_config,
        engine_config=engine_config)

    events = '''name = 2011-myanmar
time = 2011-03-24 13:55:12.010
latitude = 20.687
longitude = 99.822
magnitude = 6.9
moment = 1.9228e+19
depth = 8000
region = Myanmar
--------------------------------------------'''

    def create_struct(dirname):

        def p(fn):
            op.abspath(op.join(dirname, fn))

        os.mkdir(op.abspath(dirname))

        with open(p('config.yml'), 'w') as cf:
            cf.write(str(config))
        with open(p('events.txt'), 'w') as ef:
            ef.write(events)
        open('stations.txt', 'a').close()
        for d in dir_struct:
            os.mkdir(p(d))
Sebastian Heimann's avatar
Sebastian Heimann committed
253
254
255
256

    print config


Sebastian Heimann's avatar
Sebastian Heimann committed
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
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
272
273
def command_check(args):
    def setup(parser):
274
275
276
277
278
        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
279

Sebastian Heimann's avatar
Sebastian Heimann committed
280
281
        parser.add_option(
            '--plot', dest='show_plot', action='store_true',
282
283
            help='plot sample synthetics and data.')

284
285
286
287
        parser.add_option(
            '--waveforms', dest='show_waveforms', action='store_true',
            help='show raw, restituted, projected, and processed waveforms')

288
289
290
291
292
293
        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
294

Sebastian Heimann's avatar
Sebastian Heimann committed
295
    parser, options, args = cl_parse('check', args, setup)
296
297
    if len(args) < 2:
        help_and_die(parser, 'missing arguments')
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
298

Sebastian Heimann's avatar
Sebastian Heimann committed
299
    config_path = args[0]
300
301
    event_names = args[1:]

Sebastian Heimann's avatar
Sebastian Heimann committed
302
303
    config = grond.read_config(config_path)

304
305
306
307
    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
308
309
    grond.check(
        config,
310
        event_names=event_names,
Sebastian Heimann's avatar
Sebastian Heimann committed
311
        target_string_ids=target_string_ids,
312
        show_plot=options.show_plot,
313
        show_waveforms=options.show_waveforms,
314
        n_random_synthetics=options.n_random_synthetics)
Sebastian Heimann's avatar
Sebastian Heimann committed
315
316


Sebastian Heimann's avatar
Sebastian Heimann committed
317
318
319
320
321
322
323
324
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
325
326
327
        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
328
329

    parser, options, args = cl_parse('go', args, setup)
330
331
    if len(args) < 2:
        help_and_die(parser, 'missing arguments')
Sebastian Heimann's avatar
Sebastian Heimann committed
332
333

    config_path = args[0]
334
335
    event_names = args[1:]

Sebastian Heimann's avatar
Sebastian Heimann committed
336
337
338
339
340
341
    config = grond.read_config(config_path)
    if options.status == 'quiet':
        status = ()
    else:
        status = tuple(options.status.split(','))

Sebastian Heimann's avatar
Sebastian Heimann committed
342
343
    grond.go(
        config,
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
344
        event_names=event_names,
Sebastian Heimann's avatar
Sebastian Heimann committed
345
346
347
        force=options.force,
        status=status,
        nparallel=options.nparallel)
Sebastian Heimann's avatar
Sebastian Heimann committed
348
349
350


def command_forward(args):
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
351
    def setup(parser):
352
        pass
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
353
354

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

358
    event_names = args[1:]
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
359

Sebastian Heimann's avatar
Sebastian Heimann committed
360
361
362
    if not event_names:
        help_and_die(parser, 'no event names given')

363
    run_path = args[0]
Sebastian Heimann's avatar
wip    
Sebastian Heimann committed
364
365
366
    grond.forward(
        run_path,
        event_names=event_names)
Sebastian Heimann's avatar
Sebastian Heimann committed
367
368
369
370
371
372
373
374
375
376


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
377
378
        parser.add_option(
            '--weed', dest='weed', type=int, default=0,
379
380
381
382
383
384
385
386
387
388
389
            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
390
391
392
393
394
395

    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
396
397
398
399
400
    grond.harvest(
        run_path,
        force=options.force,
        nbest=options.neach,
        weed=options.weed)
Sebastian Heimann's avatar
Sebastian Heimann committed
401
402
403


def command_plot(args):
404
405
406
407
408
409
410
411
412
413
414
415
    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(
416
417
            '--dpi', '--dpi', dest='dpi', type=float, default=120.,
            help='DPI setting for raster formats (default=120)')
418
419
420
421
422
423
424
425
426

    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
427
428
429
    if len(args) != 2:
        help_and_die(parser, 'two arguments required')

430
431
432
433
434
435
    if args[0] == 'all':
        plotnames = plotnames_avail
    else:
        plotnames = args[0].split(',')

    formats = options.formats.split(',')
Sebastian Heimann's avatar
Sebastian Heimann committed
436
    dirname = args[1]
437
438
439
440
441
442
443
444

    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
445
446
447
448


def command_export(args):

Sebastian Heimann's avatar
Sebastian Heimann committed
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
    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
486
    else:
Sebastian Heimann's avatar
Sebastian Heimann committed
487
488
489
490
491
492
493
494
495
496
497
498
        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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522


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)