Difference between revisions of "UCVM"

From SCECpedia
Jump to navigationJump to search
 
(63 intermediate revisions by the same user not shown)
Line 1: Line 1:
The '''Unified Community Velocity Model (UCVM)''' software framework is a collection of software tools designed to provide standard interface to multiple, alternative, California 3D velocity models. One important use of UCVMC is in high resolution 3D wave propagation simulations for California. UCVM development is an interdisciplinary research collaboration involving geoscientists and computer scientists. UCVM geoscience research includes identification and assembly of existing California velocity models into a state-wide model and improvements to existing velocity models. UCVM computer science research includes definition of a easy-to-use CVM query interface, integration of regional 3D and geotechnical models, and automated CVM evaluation processing capabilities.
+
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.
  
The original version of the software is written in the C-language. An updated, python language version, of UCVM is under development under the [[UCVMC]] name.  
+
[[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 ==
 +
The current version is UCVM v22.7.0, which was released in November 2022.
  
[[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)]]
+
*[https://github.com/sceccode/ucvm.git UCVM Github Repository]
  
== UCVM Github Repository ==
+
== UCVM Documentation ==
The current UCVM software distribution has been moved to a public github repository. The UCVM Github repository is called UCVMC to identify it as the C-language version of the code. The github wiki also provides additional software documentation.
+
UCVM documentation is located on the UCVM github wiki:
*[https://github.com/SCECcode/UCVMC/wiki UCVMC Github Wiki]
+
* [https://github.com/sceccode/ucvm/wiki UCVM Github wiki].
  
This current version version of UCVM on github is a simplified version of the UCVM v15.10.0 software that was released in 2015. Essential features of that release are maintained in this version, but several optional or experimental features and models are not included to make the software easier to install, use, and maintain.
+
== 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:
 +
# [http://moho.scec.org/UCVM_web/web/viewer.php SCEC UCVM Web viewer]: Users can query UCVM velocity models, without installing UCVM, using the UCVM website.
 +
# [https://github.com/sceccode/ucvm_docker 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.
 +
# [https://github.com/sceccode/ucvm/wiki 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 ==
 
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.  
 
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. The earth structure models can be used directly without requiring UCVM. While UCVM adds complexity, it provides software capabilities that may be valuable to researchers. These UCVM specific capabilities include:
+
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:
 
 
 
#Provides standard query interface to multiple CVM models with different projections.
 
#Provides standard query interface to multiple CVM models with different projections.
 
#Converts query by elevation to query by depth to create comparable models.
 
#Converts query by elevation to query by depth to create comparable models.
 
#Provides standard methods for tri-linear interpolation, Vs30, and basin query from models.
 
#Provides standard methods for tri-linear interpolation, Vs30, and basin query from models.
 
#Provides plotting and analysis tools that make vertical profile, horizontal, and cross section plots.
 
#Provides plotting and analysis tools that make vertical profile, horizontal, and cross section plots.
#Provides tools to add gtl and ssh into models.
+
#Provides tools to add geotechnical layers and small scale heterogeneities into models.
 
#Supports tiling of models and background models.
 
#Supports tiling of models and background models.
 
#Make AWP and ETree format meshes including parallel extractions.
 
#Make AWP and ETree format meshes including parallel extractions.
  
== UCVM_System_Requirements ==
+
== Preferred UCVM Software Reference ==
Reference computing environment is the USC HPC system.
+
If you use the UCVM software in your research, please include a reference to this software. References help us obtain continued support for the software development of this code. The preferred reference for the UCVM software is:
* Centos 5.6
 
* gnu C, gfortran 4.5
 
* Python 2.7
 
* Anaconda Python packages
 
* Git client
 
* vi or emacs
 
 
 
Parallel UCVM Build Adds:
 
* MPI
 
* MPICH
 
 
 
== UCVM_Installation ==
 
UCVM installation does not require root access. It does require approximately 30G disk space for all the models to be installed. The UCVM installation establishes two directory tree, the source tree, and the installation tree. The source tree is used during the installation process, but the bin directory is where the software is installed for use. Then the source tree can be removed.
 
 
 
The UCVM software and associated installation directions are now hosted as open-source software on SCEC's github account. Please visit this site to retrieve the software source code and additional detailed installation information.
 
 
 
*[https://github.com/SCECcode/UCVMC/wiki UCVMC Github Repository]
 
  
== Previous version of UCVM ==
+
*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
Links to the previous release of UCVM is posted here:
 
*[[UCVM Users Guide]]
 
  
 
== Related Entries ==
 
== Related Entries ==
 +
*[http://www.scec.org/research/ucvm UCVM Home Page]
 
*[[USR]]
 
*[[USR]]
 +
*[[CVM-H]]
 +
*[[CVM-S]]
 +
*[[UCVMC]]
 
*[[CME Project]]
 
*[[CME Project]]

Latest revision as of 16:26, 1 August 2023

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 v22.7.0, which was released in November 2022.

UCVM Documentation

UCVM documentation is located on the UCVM github wiki:

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.

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 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

Related Entries