ucvm

UCVM is used to query seismic velocity models for earth properties (Vp, Vs, density) by lat,long, and depth. It can create velocity meshes used in seismic wave propagation simulations. This repo contains the source codes that implement the core UCVM query interface. Python-based plotting modules are hosted in a separate GitHub repo.

https://github.com/sceccode/ucvm

Keywords

research scec seismic-velocities velocity-model

Last synced: 6 months ago · JSON representation ·

Repository

UCVM is used to query seismic velocity models for earth properties (Vp, Vs, density) by lat,long, and depth. It can create velocity meshes used in seismic wave propagation simulations. This repo contains the source codes that implement the core UCVM query interface. Python-based plotting modules are hosted in a separate GitHub repo.

Basic Info

Host: GitHub
Owner: SCECcode
License: bsd-3-clause
Language: Shell
Default Branch: main
Homepage: https://www.scec.org/science/community-earth-models/
Size: 41.7 MB

Statistics

Stars: 23
Watchers: 4
Forks: 5
Open Issues: 3
Releases: 2

Topics

research scec seismic-velocities velocity-model

Created almost 5 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Codemeta

README.md

The Unified Community Velocity Model (UCVM) Software

GitHub repo size

Description

The SCEC Unified Community Velocity Model (UCVM) software framework is a collection of software tools that provide a standard query interface to seismic velocity models. Once a seismic velocity model is registered into UCVM, it can be queried and combined with other velocity models through the UCVM software interface.

UCVM was developed as 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.

UCVM 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. One important use of UCVM is to create simulation meshes used in high resolution 3D wave propagation simulations.

Installation

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.

Usage

Once installed, UCVM provides an executable program, called ucvm_query, that implements a query interface to multiple seismic velocity models.

ucvm_query

'ucvm_query' is the basic UCVM interface that queries velocity model of interest.

$ ucvm_query -f /usr/local/opt/ucvm/conf/ucvm.conf -m cvmh -l 33.84007,-117.95683,0.0

returns

 -117.9568    33.8401      0.000     34.438    293.500       cvmh   1238.170    120.690   1450.659       none      0.000      0.000      0.000      crust   1238.170    120.690   1450.65

The results are in a column oriented format. Abbreviations are like this:

Output format is:
   0   1  2  3    4     5       6     7     8     9   10      11    12       13     14      15     16
  lon lat Z surf vs30 crustal crvp crvs crrho gtl gtlvp gtlvs gtlrho cmbalgo cmbvp cmbvs cmbrho

The first three colums are the input values of lon (decimal degrees), lat (decimal degrees), and depth (meters). The other columns that are returned are information about the velocity model used provide the material properties. Crustal models, and Geotechnical Models can be stored and used seperately in UCVM. The contributions of each model are shown in columns 5-8 and 10-12, but the combined results returned in 14-16 are typically used by modelers.

Detailed descriptions of the UCVM return parameters are listed in this UCVM parameter summary provided in the UCVM documentation.

Support

Support for UCVM is provided by the Statewide California Earthquake Center (SCEC) Research Computing Group. This group supports several research software distributions including UCVM. Users can report issues and make feature requests using UCVM's github-based issue tracking link below. Developers will also respond to emails sent to the SCEC software contact listed below. 1. UCVM Github Issue Tracker 2. Email Contact: software@scec.org

Citation

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 Software Citation: Small, Patrick E., Maechling, Philip J., & Su, Mei-Hui. (2022). The Unified Community Velocity Model (UCVM) (22.7.0). Zenodo. https://doi.org/10.5281/zenodo.7033687
Example Acknowlegement: We would like to acknowledge the use of the SCEC Unified Community Velocity Model Software (Small 2022) in this research.

Along with citing the UCVM software, researchers should also cite the appropriate publication for any of the velocity models they use in their research. Citations for individual velocity models are included in the Credits file in this repository, and in the GitHub repository that has been created for each model.

Contributing

We welcome contributions to the UCVM software framework. Geoscientists can register their seismic velocity models into UCVM and software developers can improve and extend the UCVM software. An overview of the process for contributing seismic models or software updates to the UCVM Project is provided in the UCVM contribution guidelines. UCVM contributors agree to abide by the code of conduct found in our Code of Conduct guidelines.

Credits

Development of UCVM is a group effort. A list of developers that have contributed to the UCVM Software framework are listed in the Credits.md file in this repository.

License

The UCVM software is distributed under the BSD 3-Clause open-source license. Please see the LICENSE.txt file for more information.

Owner

Name: Southern California Earthquake Center
Login: SCECcode
Kind: organization
Email: software@scec.org
Location: California

Website: https://www.scec.org/
Repositories: 36
Profile: https://github.com/SCECcode

Earthquake System Science Research Center

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: The Unified Community Velocity Model (UCVM)
message: 'If you use this software, please cite it as below.'
type: software
authors:
  - family-names: Small
    given-names: Patrick E.
  - family-names: Maechling
    given-names: Philip J.
    orcid: 'https://orcid.org/0000-0002-9221-7068'
  - family-names: Su
    given-names: Mei-Hui
identifiers:
  - type: doi
    value: 10.5281/zenodo.5651276
repository-code: 'https://github.com/SCECcode/ucvm.git'
abstract: >-
  The SCEC UCVM (Unified Community Velocity Model) software
  framework is a collection of software tools that provide a
  standard query interface for accessing, comparing, and
  using community seismic velocity models in ground motion
  modeling and wave propagation simulations. 
keywords:
  - earth
  - earthquake
  - earth model
  - seismology
  - geophysics
  - earth science
  - seismic velocity model
  - seismic wave velocity
  - Vp
  - Vs
  - density
  - ground motion
  - California
  - geology
license: BSD-3-Clause
version: 25.7.0
date-released: '2025-08-16'
contact:
  - email: software@scec.org
    name: The SCEC UCVM Software project
references:
  - authors:
      - family-names: Small
        given-names: P.
      - family-names: Gill
        given-names: D.
      - family-names: Maechling
        given-names: P.J.
      - family-names: Taborda
        given-names: R.
      - family-names: Callaghan
        given-names: S.
      - family-names: Jordan
        given-names: T.H.
      - family-names: Ely
        given-names: G.P.
      - family-names: Olsen
        given-names: K.B.
      - family-names: Goulet
        given-names: C.A
    doi: 10.1785/0220170082
    keywords:
      - seismology
      - earth
      - geophysics
      - velocity models
      - tomography
    scope: Cite this paper if you want to reference the model
    title: The SCEC Unified Community Velocity Model Software Framework
    journal: Seismological Research Letters
    type: article
    issue: 5
    volume: 88
    year: 2017

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/BSD-3-Clause",
  "codeRepository": "https://github.com/SCECcode/ucvm.git",
  "dateCreated": "2007-11-30",
  "datePublished": "2008-01-14",
  "dateModified": "2022-07-01",
  "downloadUrl": "https://github.com/SCECcode/ucvm/release",
  "issueTracker": "https://github.com/SCECcode/ucvm/issues",
  "name": "SCEC Unified Community Velocity Model (UCVM)",
  "version": "22.7.0",
  "description": "The SCEC Unified Community Velocity Model (UCVM) is a collection of software tools that provide a 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 was developed by 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 is released as open-source scientific software to support earth scientists, civil engineers, and other groups interested in detailed information about earth properties. UCVM is used by scientists working with earth material properties on regional scales and is used by scientists running large-scale 3D wave propagation simulations.",
  "applicationCategory": "Seismology",
  "developmentStatus": "active",
  "referencePublication": "https://doi.org/10.1785/0220170082",
  "keywords": [
    "seismology",
    "scientific software",
    "mathematical modeling"
  ],
  "programmingLanguage": [
    "C",
    "FORTRAN",
    "Python3"
  ],
  "operatingSystem": [
    "Centos 8"
  ],
  "softwareRequirements": [
    "Python 3.5+"
  ],
  "relatedLink": [
    "https://www.scec.org/research/ucvm",
    "https://www.scec.org/research/CXM"
  ],
  "author": [
    {
      "@type": "Person",
      "givenName": "Mei-Hui",
      "familyName": "Su",
      "email": "mei@usc.edu",
      "affiliation": {
        "@type": "Organization",
        "name": "Southern California Earthquake Center, University of Southern California"
      }
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/ 0000-0002-9221-7068",
      "givenName": "Philip",
      "familyName": "Maechling",
      "email": "maechlin@usc.edu",
      "affiliation": {
        "@type": "Organization",
        "name": "Southern California Earthquake Center, University of Southern California"
      }
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Andreas",
      "familyName": "Plesch"
    },
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Marshall"
    }
  ]
}

GitHub Events

Total

Create event: 4
Release event: 1
Issues event: 6
Watch event: 5
Delete event: 5
Member event: 1
Issue comment event: 3
Push event: 251
Gollum event: 56
Pull request event: 16
Fork event: 2

Last Year

Create event: 4
Release event: 1
Issues event: 6
Watch event: 5
Delete event: 5
Member event: 1
Issue comment event: 3
Push event: 251
Gollum event: 56
Pull request event: 16
Fork event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 5
Total pull requests: 5
Average time to close issues: over 2 years
Average time to close pull requests: 1 minute
Total issue authors: 4
Total pull request authors: 1
Average comments per issue: 1.8
Average comments per pull request: 0.0
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 1
Pull requests: 5
Average time to close issues: N/A
Average time to close pull requests: 1 minute
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 0