Difference between revisions of "UCVM Command Reference"

From SCECpedia
Jump to navigationJump to search
Line 35: Line 35:
 
#ucvm_query
 
#ucvm_query
 
#vs30_query
 
#vs30_query
 +
 +
== ucvm_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
  
 
== Related Entries ==
 
== Related Entries ==
 
*[[UCVM]]
 
*[[UCVM]]

Revision as of 22:55, 3 December 2016

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

ucvm_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

Related Entries