UCVM Command Reference

UCVM Command Reference (v15.10.0)

UCVM Software Collection

The UCVM software is a software framework that builds on top of several existing scientific software packages, including CVM-H, CVM-S4, and the USGS Bay Area Model. The UCVM installation process involves first compiling the individual CVM programs, and then compiling and installed the UCVM framework.

The UCVM installation process involves two code directory trees, the src tree, and the bin tree. UCVM source codes and models are collected in the src directory tree. When UCVM is built, it is installed into a separate directory location, called the bin directory tree. Once UCVM is correctly built and installed, user configure their computing environment to point to the bin directory. All supported UCVM commands are contained in the UCVM bin tree.

Command Reference Conventions

We base our instructions and documentation assuming a standard open source software environment.

Default installation operating system is a 2015 or later Linux distribution with Python 2.7, multiple packages, gnu c and fortran compilers.

Default user shell is a bash shell and our documentation.

We will call the bin directory tree $UCVM_HOME_DIR in the command descriptions below:

UCVM commands are located in the bin tree, in several directories including $UCVM_HOME_DIR/bin, /tests, /utilities, /scripts

/bin

1. basin_query
2. ecoalesce
3. ecompact
4. grd2etree
5. grd_query
6. mesh-check
7. mesh-op
8. mesh-strip-ijk
9. patchmodel
10. run_grd.sh
11. run_ucvm.sh
12. ssh_generate
13. ssh_merge
14. ucvm2etree
15. ucvm2mesh
16. ucvm_query
17. vs30_query

basin_query

UCVM(1) BSD General Commands Manual UCVM(1)

NAME

    basin_query

SYNOPSIS

    basin_query [-h] [-f config-file] [-m model] [-v vs-threshold]

[-p usermap] [-z zmin,zmax] [-d max-depth] [-i interval] < file.in

DESCRIPTION

    The command basin_query allows you to retrieve the depth at which
    vs-threshold is first crossed. By default, vs-threshold is set to be
    1000m/s, but that can easily be changed.

    Common Paramters

    -f       Location of the UCVM configuration file. Typically, this is

../conf/ucvm.conf.

    -m       Model to query. Usually model is either cvms, cvmh, cvmsi, or

cencal.

    -v       Vs threshold to use. By default this is 1000m/s, but other com-

mon values include 2500m/s and 3000m/s.

    Less Used Parameters

    -p       Custom vs30 and elevation map location.

    -z       Custom depth range for GTL/crust interpolation.

    -d       Maximum depth, in meters, to search. Default is 15000m.

    -i       Interval, in meters, go go by when searching for the depth.

Default is 20m. So basin_query will get the Vs value at 0m, 20m, 40m, and so on.

EXAMPLE

    basin_query -f ../conf/ucvm.conf -m cvms -v 2500

Input: -118 34 Ctrl-D

Output: -118.0000 34.0000 4780.000 4780.000

SEE ALSO

    ucvm_query(1)

Linux December 3, 2016 Linux

ecoalesce

UCVM(1) BSD General Commands Manual UCVM(1)

NAME

    ecoalesce

SYNOPSIS

    ecoalesce [-h] input output

DESCRIPTION

    The command ecoalesce helps compact an e-tree file that conforms either
    to CMU or SCEC standards. It does this by replacing eight adjacent
    octants with identical material properties at level N with a single
    octant containing the same material properties at level N-1. Usually,
    this command is run with ecompact as well.

    Common Paramters

    -h       Shows the help message.

    input    E-tree input file. Typically, this was just extracted with the

ucvm2etree utilities.

    output   Compacted e-tree output.

EXAMPLE

    ecoalesce chino_hills.etree compacted_chino_hills.etree

SEE ALSO

    ecompact(1), ucvm2etree(1), ucvm2etree-extract-MPI(1),
    ucvm2etree-merge-MPI(1), ucvm2etree-sort-MPI(1)

Linux December 3, 2016 Linux

ucvm_query

UCVM(1) BSD General Commands Manual UCVM(1)

NAME

    ucvm_query

SYNOPSIS

    ucvm_query [-h] [-f config] [-m model] [-c coordtype] [-p map] [-v]

[-z zmin,zmax]

DESCRIPTION

    The command ucvm_query queries an installed velocity model to retreive
    its material properties at a particular latitude and longitude.

    Any set of crustal and GTL velocity models may be selected and queried in
    order of preference. Points may be queried by (lon,lat,dep) or
    (lon,lat,elev) and the coordinate conversions for a particular model are
    handled transparently.

    Common Paramters

    -h       Displays the help message.

    -f       Location of the configuration file, config, that tells the pro-

gram which velocity models are installed.

    -m       A comma-separated list of models to query.

    Less Used Parameters

    -c       Z-coordinate mode. Geo-depth (default) is "gd", but queries can

also be done by elevation as specified by "ge".

    -p       User-defined map of vs30 and elevation data.

    -v       Display model version information only.

    -z       Specifies depth range for gtl/crust interpolation.

EXAMPLE

    ucvm_query -f ../conf/ucvm.conf -m cvms

    Input format is:

lon lat Z

    Output format is:

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

    If running in interactive mode, please use Ctrl-D to end the input.

SEE ALSO

    basin_query(1)

Linux December 3, 2016 Linux

Related Entries

• UCVM