TauP SetMS3

TauP setms3 saves travel times into the extra headers of miniseed3 records. The source depth and distance used for the calculations can be provided on the command line or can be extracted from bag style json in extra headers in the records.

In the simplest case, with miniseed3 records that contain bag style extra headers with earthquake depth and station distance, travel times can be calculated by just giving the phases of interest. Alternatively, a depth and distance can be given, or earthquake and station information can be extracted from QuakeML and StationXML files.

For example, if the records in my_earthquake.ms3 have bag style extra headers, then this will add markers to the extra headers for P and S:

taup setms3 -p P,S my_earthquake.ms3

The usage is:

Usage: taup setms3 [--amp] [--debug] [--geodetic] [--help] [--verbose] [--taupeh
                   [=<ehKey>]] [--attenuationfreq=<attenuationFreq>]
                   [--geodeticflattening=f] [--mw=<mw>]
                   [--numattenuationfreq=<numFrequencies>]
                   [--prop=<toolPropsFilename>] [--qml=<quakemlFilename>]
                   [--qmltol=<quakeOTimeTol>] [--staxml=<stationxmlFilename>]
                   [--eid=evt[,evt...]]... [--sid=sta[,sta...]]...
                   [--strikediprake=strike dip rake]... [[--mod=<modelName>]
                   [-h=depth[,depth...]]... [--stadepth=depth[,depth...]]...
                   [--scat=depth deg]...] [[-p=phase[,phase...]]...
                   [--phasefile=<phaseFiles>]...] [mseed3file...]
Save travel times in the extra header of miniseed3 files.
    https://crotwell.github.io/ms3eh/
has details on the JSON structure.

      [mseed3file...]      Miniseed3 files to process.

Options:

      --amp                show amplitude factor for each phase
      --attenuationfreq=<attenuationFreq>
                           attenuation frequency for amplitude calculations,
                             default is 1.0
      --debug              enable debugging output
      --eid=evt[,evt...]   event id, like us7000pn9s, for lookup via USGS fdsn
                             event web service. Creates a distance if station
                             is also given.
      --geodetic           use geodetic latitude for distance calculations,
                             which implies an ellipticity. Default is
                             spherical. Note this only affects calculation of
                             distance from lat/lon pairs, all travel time
                             calculations are done in a purely spherical model.
      --geodeticflattening=f
                           Inverse Elliptical flattening for distance
                             calculations when --geodetic, defaults to WGS84 ~
                             298.257. The distance calculation uses 1/x.
      --help               display this help message
      --mw=<mw>            scale amplitude by source moment magnitude, default
                             is 4.0
      --numattenuationfreq=<numFrequencies>
                            number attenuation frequencies for amplitude
                             calculations, default is 64
      --prop=<toolPropsFilename>
                           load defaults from properties file
      --qml, --quakeml=<quakemlFilename>
                           QuakeML file to load for earthquake origins to use
      --qmltol=<quakeOTimeTol>
                           time window to search for origins in a QuakeML file
                             as an ISO8601 string, default value is PT1H.
      --sid=sta[,sta...]   station id, like CO.HAW or FDSN:CO_HAW, for lookup
                             via fedcat web service. Creates a distance if
                             event is also given.
      --staxml=<stationxmlFilename>
                           StationXML file to extract station latitudes and
                             longitudes from
      --strikediprake=strike dip rake
                           fault strike, dip and rake for amplitude
                             calculations. If not given radiation pattern is
                             unity in all directions.
      --taupeh[=<ehKey>]   key to store full TauP JSON output within extra
                             headers within, otherwise use abbreviated 'bag'
                             style markers.If specified without parameter,
                             extra header key of taup will be used.
      --verbose            enable verbose output
Model Args
  -h, --evdepth, --sourcedepth=depth[,depth...]
                           source depth in km
      --mod, --model=<modelName>
                           use velocity model "modelName" for calculations.
                           Default is iasp91. Other builtin models include
                             prem, ak135, ak135fcont, and ak135favg.
      --scat, --scatter=depth deg
                           scattering depth and distance in degrees, which may
                             be negative. Only effects phases with 'o' or 'O'
                             in the phase name.
      --stadepth, --receiverdepth=depth[,depth...]
                           the receiver depth in km for stations not at the
                             surface
Phase Names
  -p, --ph, --phase=phase[,phase...]
                           seismic phase names
      --phasefile=<phaseFiles>
                           read list of phase names from file