Difference between revisions of "UCVM"

From SCECpedia
Jump to navigationJump to search
 
(42 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 UCVM 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.
  
 
[[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 ==
 +
The current version is UCVM v22.7.0, which was released in November 2022.
 +
 +
*[https://github.com/sceccode/ucvm.git UCVM Github Repository]
 +
 +
== UCVM Documentation ==
 +
UCVM documentation is located on the UCVM github wiki:
 +
* [https://github.com/sceccode/ucvm/wiki 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:
 +
# [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. In most cases, the earth structure models accessible through UCVM can be used directly without requiring UCVM. While UCVM adds complexity, it provides software capabilities that may be valuable to researchers. Researchers may choose to use the UCVM software, in order to access one or more UCVM specific capabilities, which 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.
Line 15: Line 30:
 
#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
 
 
 
== Current UCVM Software Releases ==  
 
As of August 2017,  the current "approved" version of UCVM is the C language version of the code that we call it UCVM v17.1 (or ucvm-17.1.0). This distribution is a simplified and improved version of the UCVM v15.10.0 (ucvm-15.10.0) software release. If you are installing UCVM for the first time on a Linux computer, we recommend using UCVM v17.1.0 because it includes all available updates, and is easier to install. UCVM v17.1 is a C-language implementation of UCVM that can be compiled using GNU C programming tools. This UCVM v17.1 software replaces the previous UCVM software version, called UCVM v15.10, released in 2015. The UCVM v17.1 release removes some features from the previous version so the code is simplified and more maintainable.
 
 
 
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 v17.1.0 source code is distributed using a github repository including the source code, installation directions for Linux, and a wiki that provide examples and the expected results from UCVM.
 
*[https://github.com/SCECcode/UCVMC UCVM v17.1 Git Hub Repository (UCVM v17.1 release)] - Released January 2017
 
*[https://github.com/SCECcode/UCVMC/wiki UCVM v17.1 Git Hub Wiki]
 
 
 
== Python UCVM - Beta Version Installation ==
 
SCEC also has developed a beta version of UCVM that we call UCVM v17.3.0. We consider this a beta version of UCVM. This new version of UCVM has several potential benefits over previous versions, including:
 
* A central California model (CCA06) that is not included in UCVM v17.1.0
 
* Tools for creating meshes in the RWG format, and Hercules formats
 
* Parallel mesh construction tools for high resolution mesh creation
 
* Expanded test and usage examples showing expected results
 
* Easier installation on Linux computers.
 
 
 
SCEC has posted the open-source UCVM software and associated installation in a public github repository. Please visit this site to retrieve the software source code and additional detailed installation information.
 
*[https://github.com/SCECcode/UCVM Python UCVM Github Repository] (UCVM v17.3 - Beta Release)
 
*[https://github.com/SCECcode/UCVM/wiki Python UCVM Github Wiki] (UCVM v17.3 - Beta Release Documentation)
 
  
== Earlier 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. For C-language UCVM users, we recommend working with the current version V17.1.
 
*[[UCVM Users Guide]]
 
  
 
== Related Entries ==
 
== Related Entries ==

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