SeisBP

A simple library to read and write seismic data using ADIOS2 binary pack format.

Run test

Run from SeisBP base directory

python -m seisbp.test

Basic usage

Write (see seisbp/test.py)

from obspy import read, read_events, read_inventory

with SeisBP('test.bp', 'w') as bp:
   # write event data
   bp.write(read_events('C201107191935A'))
   bp.write(read_events('C201107191935A.tag_a'), 'tag_a')

   # write station data
   bp.write(read_inventory('AZ.FRD.xml'))
   bp.write(read_inventory('AZ.FRD.tag_c.xml'), 'tag_c')

   # write trace data
   tr = read('AZ.GRD.BHZ.sac')
   tr_tag_b = read('AZ.GRD.BHZ.tag_b.sac')

   bp.write(tr)
   bp.write(tr_tag_b, 'tag_b')
   bp.write_trace_params(tr[0], {'trace_par': 'abc'})

   # write auxiliary data
   bp.write_auxiliary('aux', tr[0].data)
   bp.write_auxiliary('aux2', {'param_a': 'a'})
   bp.write_auxiliary('aux3', (tr_tag_b[0].data, {'param_b': True}), 'tag_d')

Read

with SeisBP('test.bp', 'r') as bp:
   # read indexing
   assert bp.events() == bp.events('tag_a') == {'C201107191935A'}
   assert bp.stations() == bp.stations('tag_c') == {'AZ.FRD'}
   assert bp.waveforms() == bp.waveforms('tag_b') == {'AZ.FRD'}
   assert bp.traces('AZ.FRD') == {'.BHZ'}
   assert bp.traces('AZ.FRD', tag='tag_b') == {'S3.BHZ'}
   assert bp.auxiliaries() == {'aux', 'aux2'}
   assert bp.auxiliaries('tag_d') == {'aux3'}

   # read tags
   assert bp.event_tags('C201107191935A') == {'', 'tag_a'}
   assert bp.station_tags('AZ.FRD') == {'', 'tag_c'}
   assert bp.waveform_tags('AZ.FRD') == {'', 'tag_b'}
   assert bp.auxiliary_tags('aux') == {''}
   assert bp.auxiliary_tags('aux3') == {'tag_d'}

   # read event data
   assert bp.read_event('C201107191935A') == read_events('C201107191935A')[0]
   assert bp.read_event('C201107191935A', 'tag_a') == read_events('C201107191935A.tag_a')[0]

   # read station data
   assert bp.read_station('AZ.FRD') == read_inventory('AZ.FRD.xml')
   assert bp.read_station('AZ.FRD', 'tag_c') == read_inventory('AZ.FRD.tag_c.xml')

   # read trace data
   tr = read('AZ.GRD.BHZ.sac')
   tr_tag_b = read('AZ.GRD.BHZ.tag_b.sac')

   assert bp.traces('AZ.FRD') == {'.BHZ'}
   assert bp.components('AZ.FRD') == {'Z'}
   assert bp.read_traces('AZ.FRD', '.BHZ')[0].stats.endtime == bp.read_waveforms('AZ.FRD')[0].stats.endtime
   assert all(bp.read_traces('AZ.FRD')[0].data == tr[0].data)
   assert all(bp.read_traces('AZ.FRD', mode='data')[0] == tr[0].data)
   assert bp.read_traces('AZ.FRD', mode='params')[0] == bp.read_trace_params(tr[0]) == {'trace_par': 'abc'}
   assert bp.read_traces('AZ.FRD', mode='params', tag='tag_b') == [{}]
   assert bp.read_trace_params(tr[0], tag='tag_b') == {}
   assert all(bp.read_traces('AZ.FRD', None, tag='tag_b')[0].data == tr_tag_b[0].data)
   assert all(bp.read_traces('AZ.FRD', 'Z', tag='tag_b')[0].data == tr_tag_b[0].data)
   assert all(bp.read_traces('AZ.FRD', 'S3.BHZ', tag='tag_b')[0].data == tr_tag_b[0].data)
   assert all(bp.read_traces('AZ.FRD', 'BHZ', 'trace', 'tag_b')[0].data == tr_tag_b[0].data)

   # read auxiliary data
   assert all(bp.read_auxiliary('aux')[0] == tr[0].data)
   assert bp.read_auxiliary('aux2')[1] == {'param_a': 'a'}

   assert all(bp.read_auxiliary('aux3', 'tag_d')[0] == tr_tag_b[0].data)
   assert bp.read_auxiliary('aux3', 'tag_d')[1] == {'param_b': True}

   print('test complete')