Skip to content

Commit

Permalink
Add minimal details to README.md and add version 1.0 documents
Browse files Browse the repository at this point in the history
  • Loading branch information
chad committed Mar 26, 2015
1 parent 963dc6d commit 58bd1e7
Show file tree
Hide file tree
Showing 4 changed files with 1,260 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
# StationXML
The StationXML schema and related documents
The FDSN StationXML schema and related documents are maintained
by the [International Federation of Digital Seismograph Networks (FDSN)](http://www.fdsn.org/).

StationXML is a schema definition for representing the [Standard for the Exchange of Earthquake (SEED)](http://www.fdsn.org/seed_manual/SEEDManual_V2.4.pdf) metadata in XML.

SEED and StationXML are maintained by FDSN Working Group II.

## Releases

Approved releases are available from [http://www.fdsn.org/xml/station/](http://www.fdsn.org/xml/station/).
96 changes: 96 additions & 0 deletions Variations-FDSNSXML-SEED.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@

2012/12/11
An outline of the variations between FDSN-StationXML and SEED 2.4.

This should not be considered complete but highlights the major differences.


Features and content supported by SEED and not in FDSN-StationXML:

* Dictionary and lookup reference blockettes, there are no such concepts
in FDSN-StationXML.

* Data record blockettes, 100 and higher. FDSN-StationXML does not include
anything that would be included in miniSEED.

* Event and time span indexing blockettes. No event parameters and no
indexing relating to data records in files are contained in
FDSN-StationXML.

* Comment code keys, class code and units of comment level (blockette 31
referenced by 51 and 59). FDSN-StationXML contains comments but does not
retain these rather esoteric features.

* Generic Response Blockette 56, a simple response defined by a list of
corner frequencies and corner slopes, documented as not acceptable on their
own and should be combined with other response blockettes. This blockette
is not used by any metadata at the IRIS DMC, likely it is not widely used
or ever used at all.


Features and content supported by FDSN StationXML and not in SEED:

* Instead of the instrument identifier field of blockette 52,
FDSN-StationXML has structures at the Channel level for describing a
Sensor, Preamplifier and Datalogger with many details for each component
such as manufacturer, vendor, model, serial number, etc.

* Uncertainties for latitude, longitude, elevation, depth, azimuth, dip
and frequency.

* Start times and end times are allowed at the Network level, in addition
to the Station and Channel levels. The start times are required but the
end times are optional, allowing for currently operating epochs.

* Comments are allowed at the Network level, in addition to the Station and
Channel levels.

* Optionally specify a sampling rate as a ratio in addition to a required
value in samples per second.

* Name and description fields for each response filter type, similar to the
name field for blockette 61 but broadened to all response structures.

* Station and Channel entries may contain an ExternalResource element to
indicate a URL to an external report or dataless or other relevant
documentation.

* Station and Channel entries can contain CreationDate and TerminationDate
attributes. These are independent of the start and end dates that define
the epoch.

* A Station entry can include one or many Equipment elements to list the
equipment common to all channels at a station.

* A Station entry can contain a Site element that includes: name,
description, town, county, region, country.

* A Station entry can include Vault and Geology descriptions.

* A Station entry can include one or many Operators. Each Operator
designation can include an agency name, a web site and contact details.

* A Contact element, used for Operators or comment Authors, can contain
name, agency, email and phone number.

* A Comment can include an Author designation.

* An alternateCode and historicalCode may be designated in addition to the
"code" for a Network, Station or Channel.

* A generic description string is supported for Network, Station and Channel
elements.

* The storage format can be denoted for Channels as a simple string
(e.g. SEED, V0, etc.)

* The restriction status (open, closed or partial) can be denoted for a
Network, Station and Channel levels.

* A resource identifier can be associated with Equipment and response filter
entries. This can be used to identify equipment in an inventory system or
entries in a catalog of response filters.

* Using a schema extension, the time series data availability can be
described for at the Network, Station and Channel levels. Availability
can be described as either extents or a subset of spans.
98 changes: 98 additions & 0 deletions fdsn-station+availability.xsd
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
An data availability extension for FDSN StationXML (www.fdsn.org/xml/station)
The purpose of this schema is to extend the FDSN StationXML schema with structures
that document optional time series data availabilty for the BaseNodeType used
by the Network, Station and Channel Types.
This exention allows time series data availability to be described in two ways:
a) Extents, where earliest and latest are specified for Network, Station and/or Channel
b) Data spans, where a span of data is represented by a start time, end time, number
of segments contained in the span and maximum time tear within the span. Typically
this would be used in combination with a time-windowed data request to report data
availabilty during the selected window.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:fsx="http://www.fdsn.org/xml/station/1"
targetNamespace="http://www.fdsn.org/xml/station/1" elementFormDefault="qualified"
attributeFormDefault="unqualified" version="1.0">

<!-- Using fdsn-station-#.xsd as a base, this schema adds data availability to the BaseNodeType -->

<!-- The schemaLocation should be pointed, e.g. to "http://www.fdsn.org/xml/station/fdsn-station-1.0.xsd" -->
<xs:redefine schemaLocation="http://www.fdsn.org/xml/station/fdsn-station-1.0.xsd">
<xs:complexType name="BaseNodeType">
<xs:complexContent>
<xs:extension base="fsx:BaseNodeType">
<xs:sequence>
<xs:element name="DataAvailability" type="fsx:DataAvailabilityType"
minOccurs="0">
<xs:annotation>
<xs:documentation>A description of time series data availability.
This information should be considered transient and is primarily
useful as a guide for generating time series data requests. The
information for a DataAvailability:Span may be specific to the
time range used in a request that resulted in the document or
limited to the availability of data withing the request range.
These details may or may not be retained when synchronizing
metadata between data centers. </xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:redefine>

<xs:complexType name="DataAvailabilityExtentType">
<xs:annotation>
<xs:documentation> A type for describing data availability extents, the earliest and
latest data available. No information is included about the continuity of the data
is included or implied. </xs:documentation>
</xs:annotation>
<xs:attribute name="start" type="xs:dateTime" use="required"/>
<xs:attribute name="end" type="xs:dateTime" use="required"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<xs:complexType name="DataAvailabilitySpanType">
<xs:annotation>
<xs:documentation> A type for describing data availability spans, with variable
continuity. The time range described may be based on the request parameters that
generated the document and not necessarily relate to continuity outside of the
range. It may also be a smaller time window than the request depending on the data
characteristics. </xs:documentation>
</xs:annotation>
<xs:attribute name="start" type="xs:dateTime" use="required"/>
<xs:attribute name="end" type="xs:dateTime" use="required"/>
<xs:attribute name="numberSegments" type="xs:integer" use="required">
<xs:annotation>
<xs:documentation> The number of continuous time series segments contained in the
specified time range. A value of 1 indicates that the time series is continuous
from start to end. </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maximumTimeTear" type="xs:decimal" use="optional">
<xs:annotation>
<xs:documentation> The maximum time tear (gap or overlap) in seconds between time
series segments in the specified range. </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<xs:complexType name="DataAvailabilityType">
<xs:annotation>
<xs:documentation>An type for describing data availability.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Extent" type="fsx:DataAvailabilityExtentType" minOccurs="0"/>
<xs:element name="Span" type="fsx:DataAvailabilitySpanType" minOccurs="0"
maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>

</xs:schema>
Loading

0 comments on commit 58bd1e7

Please sign in to comment.