Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Laura Keyson committed Nov 18, 2020
1 parent 876df5e commit 240ebc8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/DOCUMENTATION.html
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ <h3>Definitions</h3>
<br /> We store the metrics we have calculated in a series of databases that are accessible to users through our <a href="http://service.iris.edu/mustang/">web services</a>. Most of the metrics are accessed through the <a href="http://service.iris.edu/mustang/measurements/1/">measurements service</a>, though there are also a handful of other services that are primarily related to PSDs and PDFs.<br />
<br /> If you are unfamiliar with our web services, in simple terms it is a way to input a specific URL into your webbrowser and have the requested metric values returned to you. Or, you can use your favorite language (python in the case of QuARG) to do the work for you.</p></li>
<li><p><strong>ISPAQ</strong><br />
Because MUSTANG is inherently built into the IRIS DMC, and we know that not all data streams into our archive, we have created a portable version of MUSTANG that users can install on their own computer to run metrics on their local data. This utility, <a href="https://github.com/iris-edu/ispaq">ISPAQ</a>, is a command line python tool that can write metrics to a file system or to a sqlite database. Those ISPAQ metrics that are written to a sqlite database can be accessed by QuARG by specifying the <code>Metric Source</code> from within the <code>Preference File Form</code>. This allows greater flexibility - networks can still use QuARG to find issues in their network even if the data does not get archived at the IRIS DMC and we do not have MUSTANG metrics for that data.</p></li>
Because MUSTANG is inherently built into the IRIS DMC, and we know that not all data streams into our archive, we have created a portable version of MUSTANG that users can install on their own computer to run metrics on their local data. This utility, <a href="https://github.com/iris-edu/ispaq">ISPAQ</a>, is a command line python tool that can write metrics to a file system or to a sqlite database (in ISPAQ 3.0, to be released soon). Those ISPAQ metrics that are written to a sqlite database can be accessed by QuARG by specifying the <code>Metric Source</code> from within the <code>Preference File Form</code>. This allows greater flexibility - networks can still use QuARG to find issues in their network even if the data does not get archived at the IRIS DMC and we do not have MUSTANG metrics for that data.</p></li>
</ol>
<p><br /> <a href="#toc">Back to Table of Contents</a><br />
<br /> <br /></p>
Expand Down Expand Up @@ -2010,7 +2010,7 @@ <h5>Final Report</h5>
<li><em>MUSTANG noise-mode-timeseries service</em>: the service interface for our noise mode timeseries service. This service plots the values of various frequencies (the mode value for each frequency for the day) over time so that you can see trends in the noise levels. This page lists information about how to use the service, and the URL builder (near top) can be used to create queries related to your network.</li>
<li><em>GOAT/data_available</em>: GOAT is a visual way to view when and where there are data gaps. This link takes you to a page that describes how to construct a URL to view the gaps for the data and timerange you are interested in.</li>
<li><em>Metadata Aggregator</em>: MDA displays all of the metadata that we have in our holdings, as well as the metadata from other federated data centers (the source of the metadata is listed under the “Data Center” field).</li>
<li><em>BUD stats</em>: this is currently the only public-facing interface where you can get information about whether you have data in Purgatory. The page contains a lot more information than just that, though. This page describes what we have in the BUD (Buffer of Uniform Data, the data streaming into IRIS in realtime). For each day of data that we have in the BUD, there is a link. That link will have information about all of the networks that have data in the BUD for that day. If your network has a blue M next to it, then there is metadata for all of the data for that day. But if it has a grey M, then there are some channels coming into IRIS that do not have metadata. Click on the network to dive deeper, where you now get a list of stations. Again, a blue M means that the station has complete metadata, a grey one means there is some missing. Click on the station and it will break down by channel. A blue M means that we have metadata, but channels without the icon next to it are missing metadata. For those stations, the “Purgatory” column should be marked as “True” - meaning that the data is streaming into IRIS but cannot be archived because we do not have metadata for it. These channels should either have metadata provided, the data streams should be shut off, or there could be an error in the channel name in the data or the metadata so that they do not match. By correcting the situation, we can ensure that all data that should be getting archived at the IRIS DMC will be archived.<br />
<li><em>BUD stats</em>: this is currently the only public-facing interface where you can get information about whether you have data in Purgatory, meaning that the data is streaming into IRIS but cannot be archived because we do not have metadata for it. The page contains a lot more information than just that, though. This page describes what we have in the BUD (Buffer of Uniform Data, the data streaming into IRIS in realtime). For each day of data that we have in the BUD, there is a link. That link will have information about all of the networks that have data in the BUD for that day. If your network has a blue M next to it, then there is metadata for all of the data for that day. But if it has a grey M, then there are some channels coming into IRIS that do not have metadata. Click on the network to dive deeper, where you now get a list of stations. Again, a blue M means that the station has complete metadata, a grey one means there is some missing. Click on the station and it will break down by channel. A blue M means that we have metadata, but channels without the icon next to it are missing metadata. For those stations, the “Purgatory” column should be marked as “True” - meaning that it cannot be archived. These channels should either have metadata provided, the data streams should be shut off, or there could be an error in the channel name in the data or the metadata so that they do not match. By correcting the situation, we can ensure that all data that should be getting archived at the IRIS DMC will be archived.<br />
</li>
<li><em>SeismiQuery</em>: this is a way to investigate the data holdings at IRIS, both the metadata and the actual data. There are many ways to find or view information from this page.</li>
</ul></li>
Expand Down

0 comments on commit 240ebc8

Please sign in to comment.