Skip to content

Home

Jump to bottom
meihuisu edited this page May 30, 2025 · 47 revisions

Overview of SCEC UCVM

This wiki documents SCEC's UCVM source code repository for UCVM v25.7. This version of UCVM integrates new velocity models, improves the installation proces, and incorporated GitHub Actions for CI testing workflow.

The SCEC Unified Community Velocity Model (UCVM) software is used to access information, including estimated Vp and Vs seismic wave velocities and density, about the earth's crust.

UCVM provides seismic velocity information for several California regions. Seismic velocities of rocks and sediments at shallow depths determine how strongly an area will shake. By assigning velocities to rock types in the 3-D geologic model, geologists can gain an understanding of the extent of areas of low shear velocity that are most likely to experience localized strong shaking and future earthquake damage. An important application for UCVM is for use in computer simulations of California earthquakes.

The Unified Community Velocity Model (UCVM) software framework is a collection of software tools designed to provide a standard interface to multiple, alternative, California velocity models. UCVM development is an interdisciplinary research collaboration involving geoscientists, computer scientists, and software developers. UCVM is used in high resolution 3D wave propagation simulations for California.

Changes in UCVM v25.7

One major change in UCVM v25.7 is the adaptation of PROJ 8.1.1. As the result, some of the accompany CVM model code is not backward compatiable to earlier version.

Collection of repositories in UCVM ecosystem

  1. This UCVM github repository is for the UCVM core package that provides the UCVM command line interfaces and linkable APIs.

  2. These velocity models are managed in their own github repositories

  1. UCVM matplotlib-based plotting scripts are located in the UCVM plotting package github repository. These scripts currently use Python 3.

  2. Scripts for retrieving and running UCVM Docker images are located in the UCVM Docker repository github repository.

Documentation

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.

Software and User Support

Issue Tracking:

Project Support

UCVM was developed with support from National Science Foundation (NSF), US Geological Survey (USGS), and other sources.

UCVM Developers

Contributors to UCVM development are listed in the Credits file.

Acknowledging Use of UCVM Software

References, citations, and acknowledgements help us obtain continued support for the development of the UCVM software. If you use the UCVM software in your research, please include the citation of the UCVM paper in the references/bibliography section of your publication. This is more effective than you providing in-text acknowledgements.

  • Preferred Reference: 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). doi:10.1785/0220170082

  • Preferred Citation: The SCEC Unified Community Velocity Model Software, Release Date: 6 November 2021, https://doi.org/10.5281/zenodo.5651277

  • Example Acknowlegement: We would like to acknowledge the use of the SCEC Unified Community Velocity Model Software (Small 2017) in this research.

License

The UCVM software is released using a BSD-3 open-source license. Please see the LICENSE.md file for distribution license and disclaimers. The underlying velocity models may be released under their own open-source license.

Shield: CC BY 4.0

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0

UCVM Documentation

  1. Introduction
  2. Overview and Installation
  3. Registered CVMs
    1. Model-Specific-Notes
  4. UCVM Configuration File
  5. Basic UCVM Commands
    1. Query by Elevation or Depth
    2. Ely/Jordan GTL
    3. Plotting Scripts
  6. List of Commands
    1. Manual Pages
    2. Executables
    3. Scripts
    4. Examples
  7. Tutorials
    1. ucvm_query
    2. makegrid.sh
    3. Make-Grid
    4. Adding GTL
    5. Basin-Query
    6. ucvm2mesh
    7. vs30_query
  8. UCVM-Docker
    1. Using-UCVM-Docker
  9. References
    1. UCVM Query Parameters
    2. Model Specific Query Behavior
    3. Model Specific GTLs
    4. System-specific Builds
    5. Model References
  10. Testing
    1. GTL-Testing
      1. CVM-H GTLs
      2. CVM-S5 GTLs
      3. CVM-S4 GTLs
      4. CVMSI GTLs
      5. CCA GTLs
      6. 1D GTLs
      7. BBP1D GTLs
    2. Other CVM-H-Tests
  11. Concepts
    1. GitHub Branches
    2. Vs30 Info
    3. UCVM Plotting
    4. C-API
    5. FORTRAN-API
    6. Projections
  12. Earlier Documentation
Clone this wiki locally