Difference between revisions of "UCVM"

From SCECpedia
Jump to navigationJump to search
Line 3: Line 3:
 
[[File:UCVM_Models_paper.png|356px|thumb|right|Coverage region for UCVM 2D maps (cyan) overlayed upon regions of various California 3D velocity models (CVM-S4: red, CVM-H: blue, USGS Bay Area: white)]]
 
[[File:UCVM_Models_paper.png|356px|thumb|right|Coverage region for UCVM 2D maps (cyan) overlayed upon regions of various California 3D velocity models (CVM-S4: red, CVM-H: blue, USGS Bay Area: white)]]
  
== Current UCVM Software Releases ==  
+
== Current UCVM Software Releases ==
As of June 2019, the current version is UCVM v19.4.0:
+
The current version is UCVM v21.10.0, which was released in November 2021.
  
UCVM is distributed as open-source scientific software. It can be installed compiled and run on most Linux-based computer systems if the system includes software development tools including Python, C, and Fortran compilers, and other software tools. The UCVM v19.4.0 source code is distributed using a github repository. On Github, users can find the source code, installation directions for Linux, and a wiki that provide examples and the expected results from UCVM.
+
== UCVM Installation Options ==
*[https://github.com/SCECcode/UCVMC UCVM v19.4.0 GitHub Source Code Repository (UCVM v19.4 release)] - Released May 2019
+
UCVM was developed to support seismic simulations run on high-performance computing systems, so it is designed to compile and run on Linux-based computers. Before installing UCVM, they should be aware that there are several ways to get access to UCVM without installing the software on your own Linux computer. Below we outline several of the options:
*[https://github.com/SCECcode/UCVMC/wiki UCVM v19.4.0 GitHub Wiki Documentation]
+
# SCEC UCVM Web viewer: Users can query UCVM velocity models, without installing UCVM, using the UCVM website.
 +
# UCVM Docker Images Users can run UCVM in Docker on their local computers including laptops. Users can install free Docker software on most computers (e.g. Linux, MacOS, Windows) then run an UCVM Docker image in a terminal window on their computer.
 +
# Installation Instructions for Linux Systems: User can install UCVM on Linux system. Advanced users that want to install many of the UCVM models, or that want to run large parallel queries of the CVM models, should install the UCVM software on a Linux system. UCVM software is developed on USC Center for Advanced Research Computing (CARC) Linux cluster which provide MPI libraries. The UCVM software framework has several MPI-based executables. These executables are built using the automake system if the required MPI libraries are found in the installation computing environment.
  
 
== UCVM Introduction ==
 
== UCVM Introduction ==

Revision as of 19:34, 7 November 2021

The Unified Community Velocity Model (UCVM) software framework is a collection of open-source scientific software tools designed to support earth scientists, civil engineers, and other groups interested in detailed information about earth properties. The seismic velocity models currently available through UCVM are primarily California high resolution regional scales seismic velocity models that provide Vp, Vs, and density for a defined geographic volume for a region. One important use of UCVM is by researchers performing high resolution 3D wave propagation simulations of California and other regions.

Coverage region for UCVM 2D maps (cyan) overlayed upon regions of various California 3D velocity models (CVM-S4: red, CVM-H: blue, USGS Bay Area: white)

Current UCVM Software Releases

The current version is UCVM v21.10.0, which was released in November 2021.

UCVM Installation Options

UCVM was developed to support seismic simulations run on high-performance computing systems, so it is designed to compile and run on Linux-based computers. Before installing UCVM, they should be aware that there are several ways to get access to UCVM without installing the software on your own Linux computer. Below we outline several of the options:

  1. SCEC UCVM Web viewer: Users can query UCVM velocity models, without installing UCVM, using the UCVM website.
  2. UCVM Docker Images Users can run UCVM in Docker on their local computers including laptops. Users can install free Docker software on most computers (e.g. Linux, MacOS, Windows) then run an UCVM Docker image in a terminal window on their computer.
  3. Installation Instructions for Linux Systems: User can install UCVM on Linux system. Advanced users that want to install many of the UCVM models, or that want to run large parallel queries of the CVM models, should install the UCVM software on a Linux system. UCVM software is developed on USC Center for Advanced Research Computing (CARC) Linux cluster which provide MPI libraries. The UCVM software framework has several MPI-based executables. These executables are built using the automake system if the required MPI libraries are found in the installation computing environment.

UCVM Introduction

The Unified Community Velocity Model (UCVM) software is open-source scientific software designed to support earth scientists, civil engineers, and other groups interested in detailed information about earth properties. UCVM is primarily used by scientists to work with earth material properties on regional scales.

UCVM software provides a software interface to one or more existing earth structure models. Researchers may choose to use the UCVM software, in order to access one or more UCVM specific capabilities, which include:

  1. Provides standard query interface to multiple CVM models with different projections.
  2. Converts query by elevation to query by depth to create comparable models.
  3. Provides standard methods for tri-linear interpolation, Vs30, and basin query from models.
  4. Provides plotting and analysis tools that make vertical profile, horizontal, and cross section plots.
  5. Provides tools to add geotechnical layers and small scale heterogeneities into models.
  6. Supports tiling of models and background models.
  7. Make AWP and ETree format meshes including parallel extractions.

Required Computing Environment

UCVM is distributed as a open-source software distribution. UCVM users should install, and build the UCVM software on their own Linux computer. UCVM software requires several existing software packages. During UCVM software development, SCEC uses USC High Performance Computing as our standard build and run environment. It is representative of shared academic research computing environments. For UCVM v19.4.0 release, the USC HPC reference computing environment includes:

  • Centos 7.0
  • gnu C, gfortran 4.8
  • Python 2.7
  • Anaconda Python packages
  • Git client
  • vi or emacs

Parallel UCVM Build Adds:

  • OpenMPI implementation of MPI standard

Preferred UCVM Software Reference

If you use the UCVM software in your research, please include a reference to this software. References help us obtain continued financial support for the software development of this code. The preferred reference for the UCVM software is:

  • Small, P., Gill, D., Maechling, P. J., Taborda, R., Callaghan, S., Jordan, T. H., Ely, G. P., Olsen, K. B., & Goulet, C. A. (2017). The SCEC Unified Community Velocity Model Software Framework. Seismological Research Letters, 88(5). https://doi.org/doi:10.1785/0220170082

UCVM Publications

The following documents provide overview of the UCVM software and it's use.

UCVM Query Paramater Table

Table showing UCVM Query input parameters (top) and return parameters (bottom) showing the information returned by UCVM.

Frequently Asked Questions

Earlier version of UCVM

Links to the previous release of UCVM is posted here. For C-language UCVM users, we recommend working with the current version V19.4.0

Related Entries