• Antelope Release 5.5 Mac OS X 10.8.5 2015-04-21

 

NAME

deployment2vnd - produce virutal network definition file (VND) from deployment table

SYNOPSIS

deployment2vnd  [-v] [-t] [-h] [-s subset_expression] database file

SUPPORT


Contributed code: NO BRTT support.
THIS PIECE OF SOFTWARE WAS CONTRIBUTED BY THE ANTELOPE USER COMMUNITY. BRTT DISCLAIMS ALL OWNERSHIP, LIABILITY, AND SUPPORT FOR THIS PIECE OF SOFTWARE.

FOR HELP WITH THIS PIECE OF SOFTWARE, PLEASE CONTACT THE CONTRIBUTING AUTHOR.

DESCRIPTION

deployment2vnd takes information from an input deployment database table and produces a comma separated virtual network definition file (VND) for use at the DMC. The deployment table is an extension of the css3.0 schema and is generally filled in using the dbe editor. A full description of the deployment table can be found by using dbhelp on a css3.0 database, or by reviewing the Description of a Deployment Table section below.

Note, the deployment table has more information than a VND file. Translating multiple times between a deployment table to a VND and back to a deployment table will not give you the same information.

If you wish to track the VND files that your data center generates, consider using the mk_dmc_files(1) script which will track the files generated in a dmcfiles table.

Description of a VND

From the DMC 2006 December Electronic Newsletter: "A virtual network is group of stations and/or seismic networks, representing an affiliation that goes beyond the traditional bounds of seismic networks to represent an umbrella organization or initiative. Virtual networks associate to recording stations and seismic networks either indefinitely or for some limited period of time. It is a grouping system that reflects growing partnerships between seismic institutions to undertake large projects and act as a single, newly formed entity. The virtual network naming system allows these traditional networks to have their data represented under the auspices of one or more of these initiatives." The fields in the comma separated version of the file are:
VIRTUAL NET,NETWORK,STATION,INSTALL DATE,CERT DATE, 
START DATE,START TIME, END DATE,END TIME,PRIMARY DC, 
SECONDARY DC
They are defined as follows:

Description of a Deployment Table

In an effort to keep track of all information necessary to produce a VND, an extension table to the css3.0 schema was created (see dbschema(5) and dbhelp(1)). The fields in a deployment table are:

OPTIONS

FILES

See Description of a VND for the format of a Virtual Network Definition file. These format of these files is based on an Excel spreadsheet, and as such, I expect it to change at some point.

As a "best practice", the network operations specific schema extension tables might be kept in a directory such as "dbops". Tables such as site, sitechan, network, calibration, stage, etc. normally end up in a directory called "dbmaster" in a real-time operations setting. Waveforms, the wfdisc, arrival, origin, and other event database tables are normally found in the "db" directory. Maintaining a separate "dbops" directory allows a data center to segregate these tables that may be essential for their operations, but not for a generic real-time system.

Consider using the mk_dmc_files(1) program that calls deployment2vnd(1) and tracks the generated output files in a dmcfiles extension table.

EXAMPLE

Using the deployment table found in the input database, db/usarray, create a vitual network definition file in the vnd output directory.
  % deployment2vnd db/usarray vnd/_US-TA_20070929.csv
Using the deployment table found in the input database, db/usarray, create a vitual network definition file for all _US-TA records with descriptive headers.
  % deployment2vnd -h -s "vnet=~/_US-TA/" db/usarray vnd/_US-TA.csv

SEE ALSO

vnd2deployment(1)
convert_deployment(1)
dbe(1)
dbhelp(1)
mk_dmc_files(1)
mk_dbops(1)
http://www.iris.edu/vnets

BUGS AND CAVEATS

Prior to February 2009, the deployment table used net rather than vnet. The current version of deployment2vnd uses the newer schema extension definition with vnet. To convert your older format deployment table to the newer format, use convert_deployment Works with current definition of VND file. The format is not well documented and subject to change. The DMC does not seem to care much about specific time: the VND only has resolution to the date level. I suspect that may change at some point. However, the deployment table has a full time description so this script could be modified to output time as needed. There are no current dbverify checks to make sure that the deployment table fields are consistent internally, or to check if the deployment table fields match what is available in the site, sitechan, snetsta, etc. The DMC requires null times of 12/31/2599 23:59:59.0. This is not a standard css3.0 null time so this script will convert css3.0 nulls to the time requested by the DMC.

AUTHOR

Jennifer Eakins
IGPP-SIO-UCSD
Antelope User Group Contributed Software
Printer icon