Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

Latest commit

 

History

History
59 lines (42 loc) · 5.57 KB

README.md

File metadata and controls

59 lines (42 loc) · 5.57 KB
Raw

THIS PROJECT HAS BEEN ARCHIVED

Please see [https://code.usgs.gov/ghsc/neic/algorithms/neic-traveltime)

Codacy Badge Build Status Documentation

neic-traveltime

The neic-traveltime GitHub project is a direct port of the Buland and Chapman travel-time implementation from FORTRAN to Java.

The algorithm is described in “The Computation of Seismic Travel Times”, BSSA, 1983, vol. 72, pp 1271-1301. In short, the algorithm uses a very specific interpolation of tau as a function of ray parameter to make the computation of travel times explicit (rather than implicit as for shooting rays). Although more complex, this algorithm has many advantages over traditional travel time versus distance and depth tables, particularly in terms of precision and ease of use. The dominant approximations made in the Buland and Chapman algorithm are Earth flattening and the Mohoroviĉić and Bullen power law for slowness versus depth allowing the tau and distance integrals to be evaluated in closed form.

The TauP code developed by Phillip Crotwell uses a similar algorithm and is also written in Java inviting comparison. The primary difference is that the Buland and Chapman implementation was built from the ground up for high volume, global scale, bulletin work. It currently produces all local, regional, and teleseismic phases determined by the United States Geolgical Survey National Earthquake Information Center to be useful (58 phases in all). Note that many of these phases are not used in event location, but associating them avoids splitting events. The added complexity needed to produce all these phases efficiently is significant and makes the process of adding and vetting new Earth models challenging. The other significant difference between the packages is that TauP uses linear interpolation for computational stability, while neic-traveltime uses a modified cubic spline interpolation to better capture triplications due to slowness gradients.

The neic-traveltime package also includes a variety of non-geometric phases, travel-time corrections, and earthquake location metadata needed for bulletin work. In addition to diffracted phases (Pdif, Sdif, and PKPdif extending PKPbc), estimates for Lg, high frequency, regional LR, pwP (pP reflected at the surface of the ocean), and PKPpre (the PKP precursor) are provided. Travel-time corrections include elevation, ellipticity, and bounce point (correcting for the ocean depth at the bounce point for surface reflections such as pP and PP). Travel-time metadata includes phase statistics, phase group information (e.g., for dealing with generic phase reports), and usage information (e.g., usage in the location process). The neic-traveltime package currently supports both standalone (single user) and multi-threaded server implementations.

Dependencies

  • neic-traveltime was written in Oracle Java 1.8
  • neic-traveltime is built with Apache Ant, and was written using Eclipse and netbeans. Netbeans project files, source files, and an ant build.xml are included in this project

Building

The steps to get and build neic-traveltime.jar using ant are as follows:

  1. Clone neic-traveltime.
  2. Open a command window and change directories to /neic-traveltime/
  3. To build the jar file, run the command ./gradlew build
  4. To build the jar file, run unit tests, and code coverage, run the command ./gradlew check
  5. To generate javadocs, run the command ./gradlew javadoc

To build the docker image, with docker installed and neic-traveltime built:

  1. In a command window, change directories to /neic-traveltime/
  2. To build the docker container, run the command docker build -t usgs/neic-traveltime:latest .

Using

Once you are able to build the neic-traveltime jar, simply include the jar file in your application.

To run the neic-traveltime as a web service, run the command java -jar build/libs/neic-traveltime-0.2.0-all.jar --mode=service

To run the neic-traveltime from the docker container, first create a docker volume for the temporary files with the command docker volume create tt-vol, then run the command docker run -d --name tt-test --mount source=tt-vol,target=/project/local/ -p 8080:8080 -it usgs/neic-traveltime:latest or docker-compose up if docker-compose is available.

To attach to the neic-traveltime container for debugging, use the command docker container exec -it tt-test /bin/bash

Once the web service is running, either locally or out of the container, you can access the swagger ui in a browser at http://localhost:8080/, and "try out" the traveltime service using the contents of examples/web-service-request.json or examples/web-service-plot-request.json.

Further Information and Documentation

For further information and documentation please check out the neic-traveltime Documentation Site.

File bug reports, feature requests and questions using GitHub Issues