UCVM 13.9.0 Advanced User Guide - Revision history

Davidgil: /* Installation */

2013-10-09T21:48:45Z

Installation

Davidgil: /* Installation */

2013-10-09T21:48:15Z

Installation

Maechlin at 22:10, 1 October 2013

2013-10-01T22:10:33Z

Davidgil at 22:01, 12 September 2013

2013-09-12T22:01:29Z

Davidgil: /* Advanced Features */

2013-09-12T21:59:47Z

Advanced Features

Davidgil: /* Advanced Features */

2013-09-12T21:59:32Z

Advanced Features

Davidgil: /* Adding a User-defined Velocity Model */

2013-09-12T21:59:05Z

Adding a User-defined Velocity Model

Davidgil: /* Advanced Features */

2013-09-12T21:58:25Z

Advanced Features

Davidgil: /* Advanced Features */

2013-09-12T21:57:26Z

Advanced Features

Davidgil: /* Advanced Features */

2013-09-12T21:57:00Z

Advanced Features

@@ Line 48: / Line 48: @@
 * [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvm-nci.tar.gz SCEC CVM-NCI]
 * [http://geology.utah.gov/ghp/consultants/geophysical_data/zip/wfcvm_3c.tgz Magistrale Wasatch Front CVM]
-* [http://hypocenter.usc.edu/research/ucvm/13.9.0/model/cvm-cmrg.tar.gz Graves Cape Mendocino]
+* [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvm-cmrg.tar.gz Graves Cape Mendocino]
 * [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvmlt-13.9.0.tar.gz Lin-Thurber Statewide]
 * [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvm-tape.tar.gz Tape SoCal]

@@ Line 46: / Line 46: @@
 * [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvms423.tar.gz CVM-S4.23]
 * [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cencal080.tar.gz CenCal 0.8.0]
-* SCEC CVM-NCI
+* [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvm-nci.tar.gz SCEC CVM-NCI]
 * [http://geology.utah.gov/ghp/consultants/geophysical_data/zip/wfcvm_3c.tgz Magistrale Wasatch Front CVM]
-* Graves Cape Mendocino
+* [http://hypocenter.usc.edu/research/ucvm/13.9.0/model/cvm-cmrg.tar.gz Graves Cape Mendocino]
 * [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvmlt-13.9.0.tar.gz Lin-Thurber Statewide]
-* Tape SoCal
+* [http://hypocenter.usc.edu/research/ucvm/13.9.0/models/cvm-tape.tar.gz Tape SoCal]
 We recommend following a standard directory structure for building and installing UCVM. We will call the base directory $UCVM_DIR. All models will be installed in $UCVM_DIR/model. All libraries will be installed in $UCVM_DIR/lib. This allows you to keep installation paths standardized and makes the installation process much easier.

@@ Line 1: / Line 1: @@
 == Overview ==
-'''This guide is intended for users looking to use the advanced features of UCVM. Most common functionality, including mesh generation and getting material properties from models, is described in the [http://scec.usc.edu/scecpedia/UCVM_13.9.0_User_Guide main user guide].'''
+'''This guide is intended for users looking to use the advanced features of UCVM. Most common functionality, including mesh generation and getting material properties from models, is described in the [http://scec.usc.edu/scecpedia/UCVM_13.9.0_User_Guide main user guide]. Specifically, this guide describes how users can install velocity models manually. Users may want to do this if the CVM model of interest is not installed automatically by the UCVM ucvm_setup.py script. This includes some supported, but less commonly used models, such as Lin-Thurber, and Graves Mendicino Junction model.'''
 UCVM 13.9.0 was released on September 8th, 2013 and is the latest version of the Unified Community Velocity Model (UCVM) framework available. UCVM is a collection of software utilities that are designed to make querying velocity models, building meshes, and visualizing velocity models easier to do through a uniform software interface. UCVM has been used extensively to generate meshes and e-trees that are then used for 3D wave propagation simulations within California.

← Older revision		Revision as of 22:01, 12 September 2013
Line 371:		Line 371:

	User-defined maps can be created with the ./bin/grd2etree utility.		User-defined maps can be created with the ./bin/grd2etree utility.
		+
		+	== Additional Information ==
		+
		+	Additional information, such as history, acknowledgements, etc., is available on the [http://scec.usc.edu/scecpedia/UCVM_13.9.0_User_Guide main user guide].

← Older revision		Revision as of 21:59, 12 September 2013
Line 341:		Line 341:

	Regional models may include: CVM-H, CVM-H, USGS Bay Area, 1D, or other user-defined models. Most models and maps have a maximum extent, outside of which no data is available. The exception is the generic 1D model as it has infinite extents. Applications must check the returned velocity and density values to ensure they are valid.		Regional models may include: CVM-H, CVM-H, USGS Bay Area, 1D, or other user-defined models. Most models and maps have a maximum extent, outside of which no data is available. The exception is the generic 1D model as it has infinite extents. Applications must check the returned velocity and density values to ensure they are valid.
		+

	=== Adding a User-defined Velocity Model ===		=== Adding a User-defined Velocity Model ===

← Older revision		Revision as of 21:59, 12 September 2013
Line 359:		Line 359:

	SCEC Etrees can be created with the ./bin/ucvm2etree utility. Patch models can be created with the ./bin/patchmodel utility.		SCEC Etrees can be created with the ./bin/ucvm2etree utility. Patch models can be created with the ./bin/patchmodel utility.
		+
		+
		+	=== Adding a User-defined Map ===
		+
		+	Update ${UCVM_INSTALL_DIR}/conf/ucvm.conf with the map interface and Etree
		+	path:
		+
		+	usermap1_interface=map_etree
		+	usermap2_mappath=/home/username/maps/usermap1.e
		+
		+	User-defined maps can be created with the ./bin/grd2etree utility.

← Older revision		Revision as of 21:58, 12 September 2013
Line 341:		Line 341:

	Regional models may include: CVM-H, CVM-H, USGS Bay Area, 1D, or other user-defined models. Most models and maps have a maximum extent, outside of which no data is available. The exception is the generic 1D model as it has infinite extents. Applications must check the returned velocity and density values to ensure they are valid.		Regional models may include: CVM-H, CVM-H, USGS Bay Area, 1D, or other user-defined models. Most models and maps have a maximum extent, outside of which no data is available. The exception is the generic 1D model as it has infinite extents. Applications must check the returned velocity and density values to ensure they are valid.
		+
		+	=== Adding a User-defined Velocity Model ===
		+
		+	UCVM may be extended to support any user-defined velocity model. The simplest way to add a new model is to store that model as a SCEC Etree or Patch Model, and update ${UCVM_INSTALL_DIR}/conf/ucvm.conf with the model interface and path. For example:
		+
		+	For SCEC Etrees:
		+
		+	user1_interface=model_etree
		+	user1_modelpath=/home/username/model_etree/user1.etree
		+
		+
		+	For Patch models:
		+
		+	user2_interface=model_patch
		+	user2_modelpath=/home/username/model_patch/user2.conf
		+
		+
		+	SCEC Etrees can be created with the ./bin/ucvm2etree utility. Patch models can be created with the ./bin/patchmodel utility.
		+
		+
		+	For other models that either are represented by tables, or have their own native API, UCVM may be extended to query from these models. However, this requires code modifications to the core UCVM library located in ./src/ucvm and recompilation. The general steps are:
		+
		+	* Define new model label UCVM_MODEL_MODELNAME in ucvm_dtypes.h
		+	* Create ucvm_model_modelname.h/.c containing the glue code that links the UCVM query interface to the native model interface
		+	* Modify ./src/ucvm/ucvm.c:
		+	** Add ucvm_model_modelname.h include at top
		+	** Add model lookup to ucvm_add_model() function
		+	** Add model to ucvm_get_resources() function
		+	* Modify ./src/ucvm/Makefile.am:
		+	** Add ucvm_model_modelname.o to list of libucvm.a dependencies
		+	* Modify ./configure.ac:
		+	** Define "enable-modelname", "with-modelname-lib-path", and "with-modelname-incl-path" configure options
		+	** Add library and header checks for your new model
		+	* Modify installer to customize path to your new model in ucvm.conf:
		+	** Add your new model to ./conf/Makefile.am
		+	** Add config entry for your new model to ./conf/ucvm_template.conf
		+	* Regenerate the Makefiles with ./scripts/autoconf/reconf.sh
		+	* Reconfigure and recompile UCVM, making sure to pass your new model flags to the configure utility

← Older revision		Revision as of 21:57, 12 September 2013
Line 278:		Line 278:

	If the user enables a GTL model but does not specify an interpolation function, linear interpolation is used by default. If no interpolation zone is specified, a depth range of 0 m - 350m is used.		If the user enables a GTL model but does not specify an interpolation function, linear interpolation is used by default. If no interpolation zone is specified, a depth range of 0 m - 350m is used.
		+

	=== Supported Standard Maps ===		=== Supported Standard Maps ===

@@ Line 308: / Line 308: @@
 | map_etree
 | SCEC Map Etree
 |}