read_GIA_model

  • Reads Glacial Isostatic Adjustment (GIA) files for given modeling group formats

  • Outputs spherical harmonics for the GIA rates and the GIA model parameters

  • Can also output fully normalized harmonics to netCDF4 or HDF5 formats

Calling Sequence

from gravity_toolkit.read_GIA_model import read_GIA_model
GIA_Ylms = read_GIA_model('Stokes.R2_65_.2_1.5_L120',GIA='IJ05-R2',LMAX=60)

Source code

gravity_toolkit.read_GIA_model(input_file, GIA=None, MMAX=None, DATAFORM=None, **kwargs)[source]

Reads Glacial Isostatic Adjustment (GIA) data files

Parameters:
input_file: str

full path to input GIA file

GIA: str or NoneType, default None

GIA model type to read and output

  • 'IJ05-R2': Ivins R2 GIA Models [29]

  • 'W12a': Whitehouse GIA Models [82]

  • 'SM09': Simpson/Milne GIA Models [57]

  • 'ICE6G': ICE-6G GIA Models [48]

  • 'Wu10': Wu (2010) GIA Correction [83]

  • 'AW13-ICE6G': Geruo A ICE-6G GIA Models [1]

  • 'AW13-IJ05': Geruo A IJ05-R2 GIA Models [1]

  • 'Caron': Caron JPL GIA Assimilation [7]

  • 'ICE6G-D': ICE-6G Version-D GIA Models [49]

  • 'ascii': reformatted GIA in ascii format

  • 'netCDF4': reformatted GIA in netCDF4 format

  • 'HDF5': reformatted GIA in HDF5 format

LMAX: int or NoneType, default from model

maximum degree of spherical harmonics

MMAX: int or NoneType, default None

maximum order of spherical harmonics

DATAFORM: str or NoneType, default None

Spherical harmonic data output format

  • None: output only as variables

  • 'ascii': output to ascii format (.txt)

  • 'netCDF4': output to netCDF4 format (.nc)

  • 'HDF5': output to HDF5 format (.H5)

MODE: oct, default 0o775

Permissions mode of output spherical harmonic files

Returns:
clm: np.ndarray

cosine spherical harmonic coefficients

slm: np.ndarray

sine spherical harmonic coefficients

l: np.ndarray

spherical harmonic degree

m: np.ndarray

spherical harmonic order

title: str

parameters of GIA model

citation: str

abbreviated citation for GIA model

reference: str

full citation for GIA model

url: str

url for GIA model reference

class gravity_toolkit.gia(**kwargs)[source]

Inheritance of harmonics class for reading Glacial Isostatic Adjustment (GIA) spherical harmonic datasets

Attributes:
lmax: int

maximum degree of the spherical harmonic field

mmax: int

maximum order of the spherical harmonic field

clm: np.ndarray

cosine spherical harmonics

slm: np.ndarray

sine spherical harmonics

attributes: dict

attributes of harmonics variables

filename: str

input or output filename

from_GIA(filename, **kwargs)[source]

Read a harmonics object from a GIA model file

Parameters:
filename: str

full path of input GIA file

GIA: str or NoneType, default None

GIA model type to read and output

  • 'IJ05-R2': Ivins R2 GIA Models

  • 'W12a': Whitehouse GIA Models

  • 'SM09': Simpson/Milne GIA Models

  • 'ICE6G': ICE-6G GIA Models

  • 'Wu10': Wu (2010) GIA Correction

  • 'AW13-ICE6G': Geruo A ICE-6G GIA Models

  • 'AW13-IJ05': Geruo A IJ05-R2 GIA Models

  • 'Caron': Caron JPL GIA Assimilation

  • 'ICE6G-D': ICE-6G Version-D GIA Models

  • 'ascii': reformatted GIA in ascii format

  • 'netCDF4': reformatted GIA in netCDF4 format

  • 'HDF5': reformatted GIA in HDF5 format

mmax: int or NoneType, default None

Maximum order of spherical harmonics

verbose: bool, default False

print file and variable information