rockhound.fetch_prem

rockhound.fetch_prem(*, load=True)[source]

Fetch the Preliminary Reference Earth Model (PREM).

The Preliminary reference Earth model [Dziewonsky1981] is a one-dimensional model representing the average Earth properties as a function of planetary radius. The model includes the depth, density, seismic velocities, attenuation (Q) and anisotropic parameter (\(\eta\)) on the boundaries of several Earth layers. It’s available through IRIS Data Services Products [IRIS2011] in a csv file (comma-separated values). The data is loaded into pandas.DataFrame objects.

If the file isn’t already in your data directory, it will be downloaded automatically.

Parameters:
load : bool

Wether to load the data into a pandas.DataFrame or just return the path to the downloaded data.
Returns:
prem : pandas.DataFrame or str

The loaded data or the file path to the downloaded data. The pandas.DataFrame contains the following data:

  • radius and depth in km.
  • density in g/cm³.
  • Vpv, Vph, Vsv and Vsh in km/s.
  • eta, Q_mu and Q_kappa (dimensionless).

Examples using rockhound.fetch_prem