ucvm_query - SCECcode/ucvm GitHub Wiki

ucvm_query is the most commonly used UCVM program. Users can call this program to query any of the velocity models registered in their UCVM installation.

Please note that the velocity models avialable to query depend on which models were selected when UCVM was installed. To gain access to all available models, users may want to build their own UCVM installation and include all available models.

Determine Velocity Model installed

ucvm_query -H will create a list of velocity models currently installed and available to be queried.

Model Names and Abbreviations

CVM names and naming conventions within UCVM can be confusing, largely because the CVM model names and abbreviations have changed during UCVM development, and there is not consistent use throughout the software and documentation.

From a users perspective, they need to know the model of interest, and the abbreviation that UCVM uses to refer to the CVM of interest. The following tables lists the standard CVM models available through UCVM, and the abbreviation used by the UCVM software to refer to each model.

1d : 1d crustal model based on Hadley-Kanamori
bbp1d : 1d crustal model developed for the LA Basin region
cvmh : crustal model - CVM-H v15.1
cvms : crustal model  - CVM-S4
cvms5 : crustal model - CVM-S4.25
cvmsi : crustal model - CVM-S4.26.M01
cencal : crustal model - Central California 08.30 Velocity Model

The model abbreviations in column 1 are used when calling UCVM to specify the model of interest.

ucvm_query is a Command Line Interface to All Registered CVMs

ucvm_query is the basic interface to all registered CVMs in UCVM. The usage format is as follows:

## ucvm_query

Usage: ucvm_query [-m models] [-c coordtype] [-f config] < file.in > file.out

Flags:
	-h This help message.
	-m Comma delimited list of crustal/GTL models to query in order
	   of preference.
	-c Z coordinate mode: geo-depth (gd, default), geo-elev (ge).
	-f Configuration file. Default is ./ucvm.conf.
	-v Display model version information only.

Input format is:
	lon lat Z(meters) (e.g. -118.00 34.00 0.0)

Output format is:
        lon lat Z elevation vs30_from_Map cvm_name cvm_vp(m/s) cvm_vs(m/s) cvm_rho(kg/m3) gtl_name gtl_vp gtl_vs gtl_rho combining_algorithm_name combined_vp combined_vs combined_rho

Flags:
    -h This help message.
    -m Comma delimited list of crustal/GTL models to query in order
       of preference.
    -c Z coordinate mode: geo-depth (gd, default), geo-elev (ge).
    -f Configuration file. Default is ./ucvm.conf.
    -v Display model version information only.

Input format is:
    lon lat Z(meters) (e.g. -118.00 34.00 0.0)

Return Parameters for ucvm_query

ucvm_query returns a 14 columns of data for each point. The meaning of each column is discussed below:

Output format is:
        lon lat Z elevation vs30_from_Map cvm_name cvm_vp(m/s) cvm_vs(m/s) cvm_rho(kg/m3) gtl_name gtl_vp gtl_vs gtl_rho combining_algorithm_name combined_vp combined_vs combined_rho

Col 0: lon - Input lon in decimal degrees
Col 1: lat - Input latitude in decimal degree
Col 2: Z  - Input depth (or elevation) in meters
Col 3: elevation - Returned elevation (m) from UCVMC Digital Elevation Map
Col 4: vs30_from_Map - Returned Vs30 (m/s) from a Wills-Wald site type to Vs30 relationship (for points in California), or from Wald topography relation (outside of California)
Col 5: cvm_name - Input name of user specified CVM that was queried
Col 6: cvm_vp(m/s) - Returned Vp (m/s) from specified CVM
Col 7: cvm_vs(m/s) - Returned Vs (m/s) from specified CVM
Col 8: cvm_rho(kg/m3) - Returned density (kg/m3) from specified CVM
Col 9: gtl_name - Geotechnical used to modify values in top 350m
Col 10: gtl_vp - Geotechnical layer Vp
Col 11: gtl_vs - Geotechnical Layer Vs
Col 12: gtl_rho - Geotechincal layer rho
Col 13: combining_algorithm_name - Name of algorigthm used to combine base model and GTL
Col 14: combined_vp - Returned Vp based on base model and GTL
Col 15: combined_vs - Returned Vs based on base model and GTL
Col 16: combined_rho - Returned rho based on base model and GTL

Example ucvm_query results

User can run an example query using a set of test lat,lons in a file in the installation_directory/tests/test_latlons.txt This file contains the following lines:

-bash-4.2$ more tests/test_latlons.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

This file contains depth values, so the query will use the default query by depth setting. Since this uses the default query by depth, it is not necessary to specify query by depth on the command line.

Move to the UCVMC installation directory. Then type the following command:

-bash-4.2$ ./bin/ucvm_query -f ./conf/ucvm.conf -m cvms < ./tests/test_latlons.txt
Using Geo Depth coordinates as default mode.
 -118.0000    34.0000      0.000    280.896    390.000       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    280.896    390.000       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    280.896    390.000       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    280.896    390.000       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    280.896    390.000       cvms   3660.809   2056.628   2443.042       none      0.000      0.000      0.000      crust   3660.809   2056.628   2443.042