Home
This wiki documents SCEC's UCVM source code repository for UCVM v22.7. This version of UCVM integrates new velocity models, improves the installation proces, and simplifies the codebase by moving the UCVM plotting utilities into their own repository.
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.
To simplify UCVM software development, we have separated the previous version of the UCVM software (called UCVM v21.10) into a collection of compatible software packages. The following collection of repositories are now used to manage UCVM software.
- This UCVM github repository is for the UCVM core package that provides the UCVM query interface.
- The velocity models are managed in their own github repositories (e.g. CVM-S4, CVM-H v15.1, CVM-S4.26, CVM-S4.26.M01, CVM-H v15.1 Basins).
- UCVM plotting scripts are now located in the UCVM plotting package github repository.
- Scripts for retrieving and running UCVM Docker images are located in the UCVM Docker repository github repository.
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.
- UCVM Github wiki is the main UCVM documentation.
- UCVM SCECpedia Wiki Documentation contains additional documentation describing previous versions of UCVM.
Issue Tracking:
- GitHub: UCVM Github Issues Email:
- Contact: software [at] scec [dot] usc [dot] edu
UCVM was developed with support from National Science Foundation (NSF), US Geological Survey (USGS), and other sources.
Contributors to UCVM development are listed in the Credits file.
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.
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.
