IRIS DMC IRISWS Earth Model Web Service Documentation

Description

The Earth Model web service provides access to community-contributed Earth models hosted by the IRIS’s Earth Model Collaboration data product (EMC, http://ds.iris.edu/ds/products/emc-earthmodels/). There are five service query methods:

/modelinfo

Produces a list of available Earth models along with a short summary for each.

  • Output format:
    • text (.txt, plain text)
    • JSON (.json, JavaScript Object Notation)

/model

Provides data for a model or a subset of a model via clipping and/or decimating.

  • Output format:
    • netCDF (.nc, network Common Data Form)
    • GeoCSV (.csv, tabular text formatting for geoscience data)

/isosurface

Provides isosurface data for selected variable(s) from a selected Earth model.

  • Output format:
    • netCDF (data)
    • GeoCSV (data)

/plane

Provides data from a model by intersecting the model with a plane.

  • Output format:
    • netCDF (data)
    • GeoCSV (data)
    • PNG (image)

/line

Provides data from a model by intersecting the model with a vertical line.

  • Output format:
    • netCDF (data)
    • GeoCSV (data)
    • PNG (image)

Below is a full list of service parameters and their usage.

Query Usage

NOTE: Query parameters are joined by ampersands ”&”, without blank space.


h3. /modelinfo GET Usage

/modelinfo? [model-options] [location-constraints] [depth-constraints] [filter-options] (passive-options) 

where

model-options           :: [model=<MODEL_NAME>][variable=<VAR1,VAR2,...>] 
location-constraints    :: [minlatitude=<degrees>] [maxlatitude=<degrees>] [minlongitude=<degrees>] [maxlongitude=<degrees>] 
depth-constraints       :: [mindepth=<km>] [maxdepth=<km>]
filter-options          :: [coverage=<full|partial>]
passive-options         :: [nodata=<204|404>]

(..) required
[..] optional 

See the modelinfo sample queries below.

/model GET Usage

/model? (model-options) [location-constraints] [depth-constraints]  [filter-options] (passive-options) 

where

model-options           :: (model=<MODEL_NAME>)[variable=<VAR1,VAR2,...>]
location-constraints    :: [minlatitude=<degrees>] [maxlatitude=<degrees>] [minlongitude=<degrees>] [maxlongitude=<degrees>] 
depth-constraints       :: [mindepth=<km>] [maxdepth=<km>]
filter-options          :: [decimate=<SAMPLING>]
passive-options         :: [nodata=<204|404>]

(..) required
[..] optional 

See the model sample queries below.

/isosurface GET Usage

/isosurface? (model-options) [location-constraints] [depth-constraints]  (filter-options) (passive-options) 

where

model-options           :: (model=<MODEL_NAME>)[variable=<VAR1,VAR2,...>]
location-constraints    :: [minlatitude=<degrees>] [maxlatitude=<degrees>] [minlongitude=<degrees>] [maxlongitude=<degrees>] 
depth-constraints       :: [mindepth=<km>] [maxdepth=<km>]
filter-options          :: (isovalues=<MINVALUE,[MAXVALUE]>)
passive-options         :: [nodata=<204|404>]

(..) required
[..] optional 

See the isosurface sample queries below.

/plane GET Usage

/plane? (model-options) (location-constraints) (depth-constraints)  [filter-options] (passive-options) 

where

model-options         :: (model=<MODEL_NAME>)[variable=<VAR1,VAR2,...>]
location-constraints  :: [minlatitude=<degrees>] [maxlatitude=<degrees>] [minlongitude=<degrees>] [maxlongitude=<degrees>] 
depth-constraints     :: [mindepth=<km>] [maxdepth=<km>]
plane-constraints     :: ([latitude=<degrees>] | [longitude=<degrees>] | [depth=<km>])
filter-options        :: [decimate=<SAMPLING>]
passive-options       :: [nodata=<204|404>]

(..) required
[..] optional 

See the plane sample queries below.

/line GET Usage

/line? (model-options) (location-constraints) [depth-constraints]  (passive-options) 

where

model-options         :: (model=<MODEL_NAME>)[variable=<VAR1,VAR2,...>]
location-constraints  :: (latitude=<degrees>) (longitude=<degrees>)
depth-constraints     :: [mindepth=<km>] [maxdepth=<km>] 
passive-options       :: [nodata=<204|404>]

(..) required
[..] optional 

See the line sample queries below.

Sample Queries

/modelinfo


/model


/isosurface


/plane


/line

Detailed Descriptions of each Query Parameter

parameters query method examples notes default type
Model options
model modelinfo, model, isosurface, plane, line S362WMANI Specify the model. Earth models available from EMC all models (modelinfo) string
variable All dvs
or
dvs,dvsv,dvsh
Specify the model variable(s) to extract. List of models and associated variables all model variables string or comma-separated strings (no spaces)
Location constraints
minlat[itude] All, except line 15.0 Southern boundary model limits degrees
maxlat[itude] All, except line 40.0 Northern boundary model limits degrees
minlon[gitude] All, except line -123.0 Western boundary model limits degrees
maxlon[gitude] All, except line -68.0 Eastern boundary model limits degrees
lat[itude] plane and line 25.0 latitude of vertical slice (plane) or line segment (line) none float
lon[gitude] plane and line -66.5 longitude of vertical slice (plane) or line segment (line) none float
Depth constraints
mindepth All 25.0 minimum depth model limits in km
maxdepth All 800.0 maximum depth model limits in km
depth plane only 25.0 slice depth 0.0 in km
passive-options
nodata 404 Specify which HTTP status code is returned when no data is found.1 204 204 or 404
Value constraints
isovalue isosurface only 4.0
or
2.0,4.0
isosurface value(s) for computing isosurface data from the Earth model a float or 2 comma-separated floats (no spaces)
decimate model and plane 25.0 sampling step along the geographic grid (output points every n units) model grid size integer
Output options
format All netcdf Specify output as text, json (modelinfo only), netcdf, geocsv (All except modelinfo), or png (plane & line) netcdf (text for modelinfo) string

1 By default, the service returns a HTTP response code 204, which means the request was successful, but no data (no content) was retrieved. However, because there was no “error”, no error message is generated and it may appear that the browser did nothing. To force an empty query response to display an error message, add nodata=404 to the URL.


The following table lists the logical behavior of the comma (,) for different query parameters in this service.

parameter logic N example
variable ANY OF N, unrestricted model?variable=vs,vp,dvs
isovalues RANGE INCLUSIVE N, restricted to 2 values isosurface?isovalues=-1.2,3.0
latitude longitude depth N/A no commas allowed plane?latitude=5



Problems with this service?

Please send an email report of which service you were using, your URL query, and any error feedback to:
ws-issues AT iris.washington.edu
We will address your issue as soon as possible.

IRISWS Earth Model web service

Page built 03:40:24 | v.e7d5ec69