Skip to content

Command Reference

meihuisu edited this page Aug 17, 2022 · 28 revisions

Information required in Basic UCVM Query

The basic UCVM interface is an command line executable called

  • ucvm_query
  • e.g. $ ucvm_query -f /app/ucvm/conf/ucvm.conf -m cvmh -l 33.84007,-117.95683,0.0

The input parameters to this query include:

  • Path to the location of UCVM configuraiton file (called ucvm.conf)
  • The model name of the seismic velocity model the user wants to query
  • The input data points in lon lat depth (or elevation), with lon and lat in decimal degrees, and depth or elevation in meters. Depth is given as positive meters below earth surface. Elevation is given as positive above sea level, and negative below sea level in meters.
  • The default query mode is query by depth. This is assumed if no query mode parameter is used. If the input data points are given in elevation, ucvm_query requires a command line parameter -c ge to indicate that the inputs are in elevation.

ucvm_query will print the results to sdtout in a column oriented format. Abbreviations are like this:

output format is:
   0   1  2  3    4     5       6     7     8     9   10      11    12       13     14      15     16
  lon lat Z surf vs30 crustal cr_vp cr_vs cr_rho gtl gtl_vp gtl_vs gtl_rho cmb_algo cmb_vp cmb_vs cmb_rho

The first three colums are input values, the remaining columns are information about the velocity model used provide the material properties. Crustal models, and Geotechnical Models can be stored and used seperately in UCVM. The contributions of each model are shown in columns 5-8 and 10-12.

The combined results returned in 14-16 are typically used by modelers.

Description of UCVM Query Return Parameters

Detailed descriptions of the UCVM return parameters are listed in this UCVM parameter summary provided in the image below:

Example commmand line ucvm_query

An example of a ucvm_query call in which the query point is included on the command line. For command line queries, the order of the coordinates is lat, long, depth separated by commas.

[ucvm@78ed8ac784b5 target]$ ucvm_query -f /app/ucvm/conf/ucvm.conf -m cvmh -l 33.84007,-117.95683,0.0
Using Geo Depth coordinates as default mode.
 -117.9568    33.8401      0.000     34.438    293.500       cvmh   1238.170    120.690   1450.659       none      0.000      0.000      0.000      crust   1238.170    120.690   1450.659

Example command line ucvm_query with input file

A more common usage is to create a text file with a series of lon lat depth points, then direct this input this file to ucvm_query as Linux stdin data. As an example, users can create this input data file, to perform a query by depth input. For file-based query points, the coordinates are given in order longitude latitude depth separated by spaces.

-bash-4.2$ cat test_lonlats.txt
-118.0 34.0 0.0
-118.0 34.0 50.0
-118.0 34.0 100.0
-118.0 34.0 500.0
-118.0 34.0 1000.0

The user can invoke basic ucvm_query, specifying CVM-S4 (as cvms):

-bash-4.2$ ucvm_query -f /app/ucvm/conf/ucvm.conf -m cvms < test_lonlats.txt
Using Geo Depth coordinates as default mode.
 -118.0000    34.0000      0.000    281.668    468.400       cvms    696.491    213.000   1974.976       none      0.000      0.000      0.000      crust    696.491    213.000   1974.976
 -118.0000    34.0000     50.000    281.668    468.400       cvms   1669.540    548.000   2128.620       none      0.000      0.000      0.000      crust   1669.540    548.000   2128.620
 -118.0000    34.0000    100.000    281.668    468.400       cvms   1683.174    603.470   2130.773       none      0.000      0.000      0.000      crust   1683.174    603.470   2130.773
 -118.0000    34.0000    500.000    281.668    468.400       cvms   3097.562   1656.495   2354.105       none      0.000      0.000      0.000      crust   3097.562   1656.495   2354.105
 -118.0000    34.0000   1000.000    281.668    468.400       cvms   3660.809   2056.628   2443.042       none      0.000      0.000      0.000      crust   3660.809   2056.628   2443.04

UCVM Abbreviations for seismic velocity models

  • The seismic velocity model name to be queried is passed into the ucvm_query as an abbreviation. The correct abbrevation for each model is not obvious, particulary to new users of ucvm. Please refer to cvm table for mapping.
Clone this wiki locally