ANSS Quakeml Resource Identifiers

Jeremy Fee edited this page Mar 12, 2013 · 1 revision

ANSS Quakeml Resource Identifiers

DRAFT

Last updated: 2013-03-12

Resource identifiers for methods

Labeling methods consistently is important so users can tell how data was computed.

Magnitude methodID

Quakeml magnitude methodID convention, when no more specific method is available:

quakeml:anss.org/cube/magnitudeType/CODE

Cube magnitude CODE = Magnitude abbreviation, description

B = Mb, Body wave
P = Mp, P-wave (Doug Neuhauser, UCB)
N = MbLg, "Nuttli" surface wave
C = Mc, Coda amplitude
D = Md, Coda duration
E = Me, Energy
H = Mh, "Human" assigned
I = Mi, "Tsuboi" moment
G = Mgn, MAGNUM (psuedo-empirical local)
L = Ml, Local
S = Ms, Surface wave
T = Mt, Teleseismic moment
O = Mw, Moment
W = Mwr, Regional moment

Custom Magnitude methodID

When a more specific method is known, version information about that method should be embedded in the identifier:

quakeml:anss.org/aqms/magnitudeType/CODE/VERSION

Any custom methodIDs should be documented on this wiki.

Origin methodID

Quakeml location methodID convention, when no more specific method is available:

quakeml:anss.org/cube/locationMethod/CODE

Cube location method CODE = description

A = Binder (AK)
D = Antelope (NN)
F = nonNEIC-furnished (US)
H = Hypoinverse (CI,UU,UW)
L = Earthworm "local" event (NC)
M = macroseismic or "felt" (US)
R = NEIC-furnished (US)

Custom Origin methodIDs

When a more specific method is known, version information about that method should be embedded in the identifier:

quakeml:anss.org/aqms/locationMethod/CODE/VERSION

Any custom methodIDs should be documented on this wiki.

Resource identifiers for elements (public IDs)

Quakeml is not specific about how publicIDs are to be used other than as a unique identifier.

Suggested format

Quakeml authority is essentially a domain name. It cannot include any slashes. The authority used by each anss network is required to be unique to that network. Following QuakeML standards it is defined as:

quakeml:<network>.<domain>/<type>/<code>[/<extendedid>]

Where for the ANSS these fields translate to:

  • <network> is the two character anss network code, lower-cased
  • <domain> is the anss network's main web page domain
  • <type> is the type of quakeml element
  • <code> is a unique code within the <type> as assigned by <network> ** for type "event", <code> must be the 8 character eventid as assigned by the network ** for other types, <code> just needs to be unique (and consistent; so new versions of information always use the same code)
  • <extendedid> is any additional information required to make this id unique within <type> for this event, e.g. timestamp, magnitude type

These are the domain names associated with each existing network code, although any unique domain could be used for any network.

"ak" => "quakeml:ak.anss.org"
"ci" => "quakeml:ci.anss.org"
"hv" => "quakeml:hv.anss.org"
"ld" => "quakeml:ld.www.ldeo.columbia.edu"
"nc" => "quakeml:nc.anss.org"
"nm" => "quakeml:nm.anss.org"
"pr" => "quakeml:pr.anss.org"
"us" => "quakeml:us.anss.org"
"uw" => "quakeml:uw.anss.org"
"at" => "quakeml:at.tsunami.gov"
"pt" => "quakeml:pt.tsunami.gov"

Examples:

quakeml:us.anss.org/event/c0001xgp
quakeml:us.anss.org/origin/usc0001xgp
quakeml:us.anss.org/magnitude/usc0001xgp/Mw
quakeml:us.anss.org/momentTensor/usc0001xgp/Mww

Alternative guidelines

The above suggested format may be used to generated consistent publicIDs. However, Event ID information is now represented using the ANSS Catalog Extension, and each agency may define their own rules for public IDs to support their own uses:

  • web service style URI Replacing "smi:" or "quakeml:" with "http://" to request the document or specific element from a web service.
  • mapping to/from DB tables and IDs Remains unique, and provides information about which database record produced a given element.

Guidelines:

  • The publicID in eventParameters element MUST be unique per quakeml message. This is used to identify when multiple products come from the same quakeml message.
  • The same version of an element, from the same source, SHOULD use the same publicID across all quakeml documents. So users can recognize duplicate information.
  • There are two primary options for different versions of an element from the same source:
    1. Use a publicID specific to the version: it is a unique piece of information, so it should have a unique ID.
    2. Reuse a publicID and use creationInfo/creationTime to capture version information: it is an update to an existing piece of information, so it should use the same ID.