polartoolkit.fetch#

Attributes#

Classes#

EarthDataDownloader

Either pulls login details from pre-set environment variables, or prompts user to

Functions#

get_fetches()

get all the fetch functions defined in this module.

resample_grid(grid[, spacing, region, registration])

Resample a grid to a new spacing, region, and/or registration. Method of resampling

sample_shp(name)

Load the file path of sample shapefiles

mass_change([version, hemisphere, region, spacing, ...])

Ice-sheet height and thickness changes from ICESat to ICESat-2 for both Antarctica

basal_melt([version, variable, region, spacing, ...])

Antarctic ice shelf basal melt rates for 1994-2018 from satellite radar altimetry.

buttressing(version[, variable, region, spacing, ...])

Antarctic ice shelf buttressing.

ice_vel([region, spacing, registration, hemisphere])

MEaSUREs Phase-Based Ice Velocity Maps for Antarctica and Greenland.

modis([version, hemisphere])

Load the MODIS Mosaic of Antarctica (MoA) or Greenland (MoG) imagery.

modis_moa([version])

deprecated function, use modis(hemisphere="south") instead

modis_mog([version])

deprecated function, use modis(hemisphere="north") instead

imagery()

Load the file path of Antarctic imagery geotiff from LIMA from

geomap([version, region])

Data from GeoMAP accessed from

groundingline([version])

Load the file path of two versions of groundingline shapefiles

measures_boundaries([version])

Deprecated, see the new function antarctic_boundaries instead

antarctic_boundaries(version)

Load various files from the MEaSUREs Antarctic Boundaries for IPY 2007-2009

sediment_thickness(version[, region, spacing, ...])

Load 1 of 4 'versions' of sediment thickness data.

ibcso_coverage([region])

Load IBCSO v2 data, from Dorschel et al.[1] and

ibcso(layer[, reference, region, spacing, registration])

Load IBCSO v2 data, from Dorschel et al.[1] and

bedmachine(layer[, reference, region, spacing, ...])

Load BedMachine topography data from either Greenland (v5) or Antarctica (v3), from

bedmap_points(version[, region])

Load bedmap point data, choose from Bedmap 1, 2 or 3 or all combined.

bedmap3(layer[, reference, region, spacing, ...])

Load Bedmap3 data as an xarray.DataArray

bedmap2(layer[, reference, region, spacing, ...])

Load bedmap2 data as xarray.DataArrays

rema([version, region, spacing, registration])

Load the REMA surface elevation data from Howat et al.[2]. The data

deepbedmap([region, spacing, registration])

Load DeepBedMap data, from Leong and Horgan[3] and

gravity(version[, region, spacing, registration, ...])

Loads gravity anomaly data for the Arctic and Antarctic.

etopo([region, spacing, registration, hemisphere])

Loads a grid of Antarctic topography from ETOPO1 from ETOPO1 1 Arc-Minute Global Relief Model: Procedures, Data Sources and Analysis[4].

geoid([region, spacing, registration, hemisphere])

Loads a grid of Antarctic geoid heights derived from the EIGEN-6C4 from

magnetics(version[, region, spacing, registration, ...])

Load magnetic anomaly data for the Arctic and Antarctic.

ghf(version[, region, spacing, registration])

Load 1 of 6 'versions' of Antarctic geothermal heat flux data.

gia(version[, region, spacing, registration])

Load 1 of 1 'versions' of Antarctic glacial isostatic adjustment grids.

crustal_thickness(version[, region, spacing, registration])

Load 1 of x 'versions' of Antarctic crustal thickness grids.

moho(version[, region, spacing, registration])

Load 1 of x 'versions' of Antarctic Moho depth grids.

Module Contents#

USE_ARROW = True[source]#
get_fetches()[source]#

get all the fetch functions defined in this module.

Returns:

names of each fetch function

Return type:

list[str, tuple[float, float, float, float] ]

resample_grid(grid, spacing=None, region=None, registration=None, **kwargs)[source]#

Resample a grid to a new spacing, region, and/or registration. Method of resampling depends on comparison with initial and supplied values for spacing, region, and registration. If initial values not supplied, will try and extract them from the grid.

Parameters:
  • grid (xarray.DataArray) – grid to resample

  • spacing (float | None, optional) – new spacing for grid, by default None

  • region (tuple[float, float, float, float] | None, optional) – new region for grid in format [xmin, xmax, ymin, ymax], by default None

  • registration (str | None, optional) – new registration for grid, by default None

  • kwargs (dict[str, str])

Returns:

grid, either resampled or same as original depending on inputs. If no resampling, and supplied grid is a filepath, returns filepath.

Return type:

xarray.DataArray

class EarthDataDownloader[source]#

Either pulls login details from pre-set environment variables, or prompts user to input username and password. Will persist the entered details within the python session.

__call__(url, output_file, dataset)[source]#
Parameters:
  • url (str)

  • output_file (str)

  • dataset (Any)

Return type:

None

sample_shp(name)[source]#

Load the file path of sample shapefiles

Parameters:

name (str) – chose which sample shapefile to load, either ‘Disco_deep_transect’ or ‘Roosevelt_Island’

Returns:

file path as a string

Return type:

str

mass_change(version=None, hemisphere=None, region=None, spacing=None, registration=None, **kwargs)[source]#

Ice-sheet height and thickness changes from ICESat to ICESat-2 for both Antarctica and Greenland from Smith et al.[5].

Choose a version of the data to download with the format: “ICESHEET_VERSION_TYPE” where ICESHEET is “ais” or “gris”, for Antarctica or Greenland, VERSION is “dhdt” for total thickness change or “dmdt” for corrected for firn-air content. For Antarctic data, TYPE is “floating” or “grounded”.

add “_filt” to retrieve a filtered version of the data for some versions.

accessed from https://digital.lib.washington.edu/researchworks/handle/1773/45388

Units are in m/yr

Parameters:
  • version (str, optional,) – choose which version to retrieve, by default is “ais_dhdt_grounded” for Antarctica and “gris_dhdt” for Greenland.

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (float, optional,) – grid spacing to resample the loaded grid to, by default is 5km

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is “p”.

  • kwargs (Any) – additional keyword arguments to pass to resample_grid

Returns:

Returns a grid of Antarctic or Greenland ice mass change in meters/year.

Return type:

xarray.DataArray

References

basal_melt(version='w_b', variable=None, region=None, spacing=None, registration=None, **kwargs)[source]#

Antarctic ice shelf basal melt rates for 1994-2018 from satellite radar altimetry. from Adusumilli et al.[6].

accessed from http://library.ucsd.edu/dc/object/bb0448974g

reading files and preprocessing from supplied jupyternotebooks: sioglaciology/ice_shelf_change

Units are in m/yr

Parameters:
  • version (str) – choose which version to load, either ‘w_b’ for basal melt rate, ‘w_b_interp’, for basal melt rate with interpolated values, and ‘w_b_uncert’ for uncertainty

  • variable (str | None)

  • region (tuple[float, float, float, float] | None)

  • spacing (float | None)

  • registration (str | None)

  • kwargs (Any)

Returns:

Returns a dataarray of basal melt rate values

Return type:

xarray.DataArray

References

buttressing(version, variable=None, region=None, spacing=None, registration=None, **kwargs)[source]#

Antarctic ice shelf buttressing. from FĂŒrst et al.[7].

accessed from https://nsidc.org/data/nsidc-0664/versions/1

Units are in m/yr

Parameters:
  • version (str) – choose which version to load, either ‘max’ for maximum buttressing, ‘min’ for minimum buttressing, ‘flow’ for along-flow buttressing, or ‘viscosity’ for estimated ice viscosity values

  • variable (str | None)

  • region (tuple[float, float, float, float] | None)

  • spacing (float | None)

  • registration (str | None)

  • kwargs (Any)

Returns:

Returns a dataarray of buttressing or viscosity values

Return type:

xarray.DataArray

References

ice_vel(region=None, spacing=None, registration=None, hemisphere=None, **kwargs)[source]#

MEaSUREs Phase-Based Ice Velocity Maps for Antarctica and Greenland.

Antarctica: version 1 from and Mouginot et al.[8].

accessed from https://nsidc.org/data/nsidc-0754/versions/1#anchor-1 Data part of https://doi.org/10.1029/2019GL083826

Greenland: version 1 from MEaSUREs Multi-year Greenland Ice Sheet Velocity Mosaic, Version 1[9]

accessed from https://nsidc.org/data/nsidc-0670/versions/1

Units are in m/yr

Requires an EarthData login, see Tutorials/Download Polar datasets for how to configure this.

Parameters:
  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (float, optional,) – grid spacing to resample the loaded grid to, by default is 5km for Antarctica (original data is 450m), and 250m for Greenland

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

  • kwargs (Any) – additional keyword arguments to pass to resample_grid

Returns:

Returns a calculated grid of ice velocity in meters/year.

Return type:

xarray.DataArray

References

modis(version=None, hemisphere=None)[source]#

Load the MODIS Mosaic of Antarctica (MoA) or Greenland (MoG) imagery.

Antarctica: from Haran et al.[10] and Scambos et al.[11].

accessed from https://nsidc.org/data/nsidc-0593/versions/2

Greenland: from Haran et al.[12] accessed from https://nsidc.org/data/nsidc-0547/versions/2

Requires an EarthData login, see Tutorials/Download Polar datasets for how to configure this.

Parameters:
  • version (str, optional) – for Antarctica, choose between “750m” or “125m” resolutions, by default “750m”, for Greenland, choose between “500m” or “100m” resolutions, by default “500m”

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

Returns:

filepath for MODIS Imagery

Return type:

str

References

modis_moa(version='750m')[source]#

deprecated function, use modis(hemisphere=”south”) instead

Parameters:

version (str)

Return type:

str

modis_mog(version='500m')[source]#

deprecated function, use modis(hemisphere=”north”) instead

Parameters:

version (str)

Return type:

str

imagery()[source]#

Load the file path of Antarctic imagery geotiff from LIMA from Bindschadler et al.[13]. accessed from https://lima.usgs.gov/

will replace with below once figured out login issue with pooch MODIS Mosaic of Antarctica: https://doi.org/10.5067/68TBT0CGJSOJ Assessed from https://daacdata.apps.nsidc.org/pub/DATASETS/nsidc0730_MEASURES_MOA2014_v01/geotiff/

Returns:

file path

Return type:

str

References

geomap(version='faults', region=None)[source]#

Data from GeoMAP accessed from https://doi.pangaea.de/10.1594/PANGAEA.951482?format=html#download

from Cox et al.[14] and Cox et al.[15].

Parameters:
  • version (str, optional) – choose which version to retrieve, “faults”, “units”, “sources”, or “quality”, by default “faults”

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

Returns:

Returns a geodataframe

Return type:

geopandas.GeoDataFrame

References

groundingline(version='measures-v2')[source]#

Load the file path of two versions of groundingline shapefiles

version = “depoorter-2013” from Depoorter et al.[16]. Supplement to Depoorter et al.[17]. accessed at https://doi.pangaea.de/10.1594/PANGAEA.819147

version = “measures-v2” from Mouginot et al.[18]. accessed at https://nsidc.org/data/nsidc-0709/versions/2

version = “BAS” from Gerrish[19]. accessed at https://ramadda.data.bas.ac.uk/repository/entry/show?entryid=8cecde06-8474-4b58-a9cb-b820fa4c9429

version = “measures-greenland” from Haran et al.[12].

Some versions require an EarthData login, see Tutorials/Download Polar datasets for how to configure this.

Parameters:

version (str, optional) – choose which version to retrieve, by default “measures-v2”

Returns:

file path

Return type:

str

References

measures_boundaries(version=None)[source]#

Deprecated, see the new function antarctic_boundaries instead

Parameters:

version (str | None)

Return type:

str

antarctic_boundaries(version)[source]#

Load various files from the MEaSUREs Antarctic Boundaries for IPY 2007-2009

from Mouginot et al.[18]. accessed at https://nsidc.org/data/nsidc-0709/versions/2

Requires an EarthData login, see Tutorials/Download Polar datasets for how to configure this.

Parameters:

version (str,) – choose which file to retrieve from the following list: “Coastline”, “Basins_Antarctica”, “Basins_IMBIE”, “IceBoundaries”, “IceShelf”, “Mask”

Returns:

file path

Return type:

str

References

sediment_thickness(version, region=None, spacing=None, registration=None, **kwargs)[source]#

Load 1 of 4 ‘versions’ of sediment thickness data.

version=’ANTASed’ From Baranov et al.[20]. Accessed from https://www.itpz-ran.ru/en/activity/current-projects/antased-a-new-sediment-model-for-antarctica/

version=’tankersley-2022’ From Tankersley et al.[21], Tankersley et al.[22].

version=’lindeque-2016’ From Lindeque et al.[23] and Lindeque et al.[24].

version=’GlobSed’ From Straume et al.[25]. Accessed from https://ngdc.noaa.gov/mgg/sedthick/

Parameters:
  • version (str,) – choose which version of data to fetch.

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 10e3

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • **kwargs (Any) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of sediment thickness.

Return type:

xarray.DataArray

References

ibcso_coverage(region=None)[source]#

Load IBCSO v2 data, from Dorschel et al.[1] and Dorschel et al.[26].

Parameters:

region (tuple[float, float, float, float] or None) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

Returns:

Returns two geodataframes; points and polygons for a subset of IBCSO v2 point measurement locations. Column ‘dataset_tid’ is the type identifier from IBCSO. The points geodataframe contains all individual point measurements, including single-beam (TID 10), seismic points (TID 12), isolated soundings (TID 13), ENC sounding (TID 14), grounded iceberg draft (TID 46), and gravity-inverted bathymetry (TID 45). The polygon geodataframe contains all polygon measurements, including multi-beam (swath) (TID 11), contours from charts (TID 42), or other unknown sources (TID 71).

Return type:

tuple[geopandas.GeoDataFrame, geopandas.GeoDataFrame]

References

ibcso(layer, reference='geoid', region=None, spacing=None, registration=None, **kwargs)[source]#

Load IBCSO v2 data, from Dorschel et al.[1] and Dorschel et al.[26].

By default the elevations are relative to Mean Sea Level (the geoid). To convert them to be relative to the WGS84 ellipsoid, set reference=”ellipsoid which will add the EIGEN-6C4 geoid anomaly.

Parameters:
  • layer (str) – choose which layer to fetch: ‘surface’, ‘bed’

  • reference (str, optional) – choose which vertical reference to use, ‘geoid’ or ‘ellipsoid’, by default ‘geoid’

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 500m. If spacing >= 5000m, will resample the grid to 5km, and save it as a preprocessed grid, so future fetch calls are performed faster.

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • **kwargs (Any) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of IBCSO data.

Return type:

xarray.DataArray

References

bedmachine(layer, reference='eigen-6c4', region=None, spacing=None, registration=None, hemisphere=None, **kwargs)[source]#

Load BedMachine topography data from either Greenland (v5) or Antarctica (v3), from Morlighem[27] or .

Antarctica: Accessed from NSIDC via https://nsidc.org/data/nsidc-0756/versions/3. Also available from ldeo-glaciology/pangeo-bedmachine

Greenland: Accessed from NSIDC via https://nsidc.org/data/idbmg4/versions/5

Referenced to the EIGEN-6C4 geoid. To convert to be ellipsoid-referenced, we add the geoid grid. use reference=’ellipsoid’ to include this conversion in the fetch call.

For Antarctica: Surface and ice thickness are in ice equivalents. Actual snow surface is from REMA [2], and has had firn thickness added(?) to it to get Bedmachine Surface.

To get snow surface: surface+firn To get firn and ice thickness: thickness+firn

Here, icebase will return a grid of surface-thickness This should be the same as snow-surface - (firn and ice thickness)

Requires an EarthData login, see Tutorials/Download Polar datasets for how to configure this.

Parameters:
  • layer (str) – choose which layer to fetch: ‘bed’, ‘dataid’, ‘errbed’, ‘firn’, ‘geoid’, ‘mask’, ‘source’, ‘surface’, ‘ice_thickness’; ‘icebase’ will give results of surface-thickness

  • reference (str) – choose whether heights are referenced to ‘eigen-6c4’ geoid or the ‘ellipsoid’ (WGS84), by default is eigen-6c4’

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 500m. If spacing >= 5000m, will resample the grid to 5km, and save it as a preprocessed grid, so future fetch calls are performed faster.

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

  • **kwargs (Any) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of Bedmachine.

Return type:

xarray.DataArray

References

bedmap_points(version, region=None)[source]#

Load bedmap point data, choose from Bedmap 1, 2 or 3 or all combined.

All elevations are in meters above the WGS84 ellipsoid.

version == ‘bedmap1’ from Lythe and Vaughan[28]. accessed from https://data.bas.ac.uk/full-record.php?id=GB/NERC/BAS/PDC/01619

version == ‘bedmap2’ from Fretwell et al.[29]. accessed from https://data.bas.ac.uk/full-record.php?id=GB/NERC/BAS/PDC/01616

version == ‘bedmap3’ from Fremand et al.[30]. accessed from https://data.bas.ac.uk/full-record.php?id=GB/NERC/BAS/PDC/01614#access-data download link was found from https://ramadda.data.bas.ac.uk/repository/entry/show?entryid=61100714-1e32-44af-a237-0a517529bc49 under DOI/BEDMAP3 datapoints, right click on the download link and copy link address

Parameters:
  • version (str) – choose between ‘bedmap1’, ‘bedmap2’, ‘bedmap3’, or ‘all’, point data

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

Returns:

Return a dataframe, optionally subset by a region

Return type:

pandas.DataFrame

References

bedmap3(layer, reference='eigen-gl04c', region=None, spacing=None, registration=None, fill_nans=False, **kwargs)[source]#

Load Bedmap3 data as an xarray.DataArray from . accessed from https://ramadda.data.bas.ac.uk/repository/entry/show?entryid=2d0e4791-8e20-46a3-80e4-f5f6716025d2.

All grids are by default referenced to the EIGEN-GL04C geoid. Use the reference=’ellipsoid’ to convert to the WGS-84 ellipsoid or reference=’eigen-6c4’ to convert to the EIGEN-6c4 geoid.

Unlike Bedmachine data, Bedmap2 surface and icethickness contain NaN’s over the ocean, instead of 0’s. To fill these NaN’s with 0’s, set fill_nans=True. Note, this only makes since if the reference is the geoid, therefore, if reference=’ellipsoid and fill_nans=True, the nan’s will be filled before converting the results to the geoid (just for surface, since thickness isn’t relative to anything).

Parameters:
  • layer (str) – choose which layer to fetch: “surface”, “icebase”, “bed”, “ice_thickness”, “water_thickness”, “bed_uncertainty”, “ice_thickness_uncertainty”, and “mask”.

  • reference (str) – choose whether heights are referenced to the ‘eigen-6c4’ geoid, the WGS84 ellipsoid, ‘ellipsoid’, or by default the ‘eigen-gl04c’ geoid.

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 500m. If spacing >= 5000m, will resample the grid to 5km, and save it as a preprocessed grid, so future fetch calls are performed faster.

  • registration (str, optional,) – choose between ‘g’ (gridline) or ‘p’ (pixel) registration types, by default is the original type of the grid

  • fill_nans (bool, optional,) – choose whether to fill nans in ‘surface’ and ‘thickness’ with 0. If converting to reference to the geoid, will fill nan’s before conversion, by default is False

  • **kwargs (optional) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of Bedmap2.

Return type:

xarray.DataArray

References

bedmap2(layer, reference='eigen-gl04c', region=None, spacing=None, registration=None, fill_nans=False, **kwargs)[source]#

Load bedmap2 data as xarray.DataArrays from Fretwell et al.[29]. accessed from https://ramadda.data.bas.ac.uk/repository/entry/show?entryid=fa5d606c-dc95-47ee-9016-7a82e446f2f2.

All grids are by default referenced to the EIGEN-GL04C geoid. Use the reference=’ellipsoid’ to convert to the WGS-84 ellipsoid or reference=’eigen-6c4’ to convert to the EIGEN-6c4 geoid.

Unlike Bedmachine data, Bedmap2 surface and icethickness contain NaN’s over the ocean, instead of 0’s. To fill these NaN’s with 0’s, set fill_nans=True. Note, this only makes since if the reference is the geoid, therefore, if reference=’ellipsoid and fill_nans=True, the nan’s will be filled before converting the results to the geoid (just for surface, since thickness isn’t relative to anything).

Parameters:
  • layer (str) – choose which layer to fetch: “bed”, “coverage”, “grounded_bed_uncertainty”, “icemask_grounded_and_shelves”, “lakemask_vostok”, “rockmask”, “surface”, “ice_thickness”, “ice_thickness_uncertainty”, “gl04c_geiod_to_WGS84”, “icebase”, “water_thickness”

  • reference (str) – choose whether heights are referenced to the ‘eigen-6c4’ geoid, the WGS84 ellipsoid, ‘ellipsoid’, or by default the ‘eigen-gl04c’ geoid.

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 1000m. If spacing >= 5000m, will resample the grid to 5km, and save it as a preprocessed grid, so future fetch calls are performed faster.

  • registration (str, optional,) – choose between ‘g’ (gridline) or ‘p’ (pixel) registration types, by default is the original type of the grid

  • fill_nans (bool, optional,) – choose whether to fill nans in ‘surface’ and ‘thickness’ with 0. If converting to reference to the geoid, will fill nan’s before conversion, by default is False

  • **kwargs (optional) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of Bedmap2.

Return type:

xarray.DataArray

References

rema(version='1km', region=None, spacing=None, registration=None, **kwargs)[source]#

Load the REMA surface elevation data from Howat et al.[2]. The data are in EPSG3031 and reference to the WGS84 ellipsoid. To convert the data to be geoid-referenced, subtract a geoid model, which you can get from fetch.geoid().

Choose between “1km” or “500m” resolutions with parameter version.

accessed from https://www.pgc.umn.edu/data/rema/

Parameters:
  • version (str, optional,) – choose which resolution to fetch, either “1km” or “500m”, by default is “1km”

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 10e3

  • registration (str, optional,) – choose between ‘g’ (gridline) or ‘p’ (pixel) registration types, by default is the original type of the grid

  • **kwargs (optional) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of the REMA DEM.

Return type:

xarray.DataArray

References

deepbedmap(region=None, spacing=None, registration=None, **kwargs)[source]#

Load DeepBedMap data, from Leong and Horgan[3] and Leong and Horgan[31].

Parameters:
  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 10e3

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • **kwargs (optional) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns the grid of DeepBedMap.

Return type:

xr.DataArray

References

gravity(version, region=None, spacing=None, registration=None, hemisphere=None, **kwargs)[source]#

Loads gravity anomaly data for the Arctic and Antarctic.

version=’antgg’ Antarctic-wide gravity data compilation of ground-based, airborne, and shipborne data, from Scheinert et al.[32]. Accessed from https://doi.pangaea.de/10.1594/PANGAEA.848168 Anomalies are at the ice surface, or bedrock surface in areas of no ice. These surfaces are defined by Bedmap2 and are relative to the ellipsoid.

version=’antgg-2021’ Updates on 2016 AntGG compilation. Accessed from https://doi.pangaea.de/10.1594/PANGAEA.971238?format=html#download Anomalies are at the ice surface, or bedrock surface in areas of no ice. These surfaces are defined by Bedmap2 and are relative to the ellipsoid.

version=’eigen’ Earth gravity grid (eigen-6c4) at 10 arc-min resolution at 10km geometric (ellipsoidal) height from Förste et al.[33]. originally from https://dataservices.gfz-potsdam.de/icgem/showshort.php?id=escidoc:1119897 Accessed via the Fatiando data repository fatiando-data/earth-gravity-10arcmin

Parameters:
  • version (str) – choose which version of gravity data to fetch.

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 10e3

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

  • kwargs (Any) – additional kwargs to pass to resample_grid and set the anomaly_type.

Keyword Arguments:

anomaly_type (str) – either ‘FA’ or ‘BA’, for free-air and bouguer anomalies, respectively. For antgg-update can also be ‘DG’ for gravity disturbance, or ‘Err’ for error estimates.

Returns:

Returns a loaded, and optional clip/resampled grid of either observed, free-air or Bouguer gravity anomalies.

Return type:

xarray.DataArray

References

etopo(region=None, spacing=None, registration=None, hemisphere=None, **kwargs)[source]#

Loads a grid of Antarctic topography from ETOPO1 from ETOPO1 1 Arc-Minute Global Relief Model: Procedures, Data Sources and Analysis[4]. Originally at 10 arc-min resolution, reference to mean sea-level (geoid).

originally from https://www.ncei.noaa.gov/access/metadata/landing-page/bin/iso?id=gov.noaa.ngdc.mgg.dem:316 Accessed via the Fatiando data repository fatiando-data/earth-topography-10arcmin

Parameters:
  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 10e3

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

  • **kwargs (optional) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of topography.

Return type:

xarray.DataArray

References

geoid(region=None, spacing=None, registration=None, hemisphere=None, **kwargs)[source]#

Loads a grid of Antarctic geoid heights derived from the EIGEN-6C4 from Förste et al.[33] spherical harmonic model of Earth’s gravity field. Originally at 10 arc-min resolution. Negative values indicate the geoid is below the ellipsoid surface and vice-versa. To convert a topographic grid which is referenced to the ellipsoid to be referenced to the geoid, add this grid. To convert a topographic grid which is referenced to the geoid to be referencde to the ellipsoid, add this grid.

originally from https://dataservices.gfz-potsdam.de/icgem/showshort.php?id=escidoc:1119897 Accessed via the Fatiando data repository fatiando-data/earth-geoid-10arcmin DOI: 10.5281/zenodo.5882205

Parameters:
  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 10e3

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

  • kwargs (Any) – additional kwargs to pass to resample_grid.

Returns:

Returns a loaded, and optional clip/resampled grid of geoid height.

Return type:

xarray.DataArray

References

magnetics(version, region=None, spacing=None, registration=None, hemisphere=None, **kwargs)[source]#

Load magnetic anomaly data for the Arctic and Antarctic. from Golynsky et al.[34] and Golynsky et al.[35].

version=’admap1’ ADMAP-2001 magnetic anomaly compilation of Antarctica. Accessed from http://admap.kopri.re.kr/databases.html

version=’admap2’ ADMAP2 magnetic anomaly compilation of Antarctica from Golynsky et al.[36]. Accessed from https://doi.pangaea.de/10.1594/PANGAEA.892723?format=html#download

version=’admap2_gdb’ Geosoft-specific .gdb abridged files Golynsky et al.[37]. Accessed from https://doi.pangaea.de/10.1594/PANGAEA.892722?format=html#download

version=’LCS-1’ Satellite-only derived magnetic anomaly at Earth’s surface (WGS84 ellipsoid) for spherical harmonic degrees n=14-185 Accessed from https://www.spacecenter.dk/files/magnetic-models/LCS-1/

Parameters:
  • version (str) – Either ‘admap1’, ‘admap2’, ‘admap2_gdb’ or ‘LCS-1’.

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (str or int, optional) – grid spacing to resample the loaded grid to, by default 10e3

  • registration (str, optional,) – choose between ‘g’ (gridline) or ‘p’ (pixel) registration types, by default is the original type of the grid

  • hemisphere (str, optional) – choose which hemisphere to retrieve data for, “north” or “south”, by default None

  • kwargs (Any) – key word arguments to pass to resample_grid.

Returns:

Returns a loaded, and optional clip/resampled grid of magnetic anomalies.

Return type:

xarray.DataArray

References

ghf(version, region=None, spacing=None, registration=None, **kwargs)[source]#

Load 1 of 6 ‘versions’ of Antarctic geothermal heat flux data.

version=’an-2015’ From An et al.[38]. Accessed from http://www.seismolab.org/model/antarctica/lithosphere/index.html

version=’martos-2017’ From Martos et al.[39] and Martos[40]. Accessed from https://doi.pangaea.de/10.1594/PANGAEA.882503

version=’shen-2020’: From Shen et al.[41]. Accessed from https://sites.google.com/view/weisen/research-products?authuser=0 Used https://paperform.co/templates/apps/direct-download-link-google-drive/ to generate a direct download link from google drive page. https://drive.google.com/uc?export=download&id=1Fz7dAHTzPnlytuyRNctk6tAugCAjiqzR

version=’burton-johnson-2020’ From Burton-Johnson et al.[42]. Accessed from supplementary material Choose for either of grid, or the point measurements

version=’losing-ebbing-2021’ From Lösing and Ebbing[43] and Lösing and Ebbing[44]. Accessed from https://doi.pangaea.de/10.1594/PANGAEA.930237

version=’aq1’ From StĂ„l et al.[45] and StĂ„l et al.[46]. Accessed from https://doi.pangaea.de/10.1594/PANGAEA.924857

Parameters:
  • version (str) – Either ‘burton-johnson-2020’, ‘losing-ebbing-2021’, ‘aq1’,

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (int, optional) – grid spacing to resample the loaded grid to, by default spacing is read from downloaded files

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • kwargs (Any) – if version=’burton-johnson-2020’, then kwargs are passed to return point measurements instead of the grid.

  • **kwargs (Any) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of GHF data.

Return type:

xarray.DataArray

References

gia(version, region=None, spacing=None, registration=None, **kwargs)[source]#

Load 1 of 1 ‘versions’ of Antarctic glacial isostatic adjustment grids.

version=’stal-2020’ From StĂ„l et al.[47] and StĂ„l et al.[48].

Parameters:
  • version (str) – For now the only option is ‘stal-2020’,

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (int, optional) – grid spacing to resample the loaded grid to, by default spacing is read from downloaded files

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • **kwargs (Any) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of GIA data.

Return type:

xarray.DataArray

References

crustal_thickness(version, region=None, spacing=None, registration=None, **kwargs)[source]#

Load 1 of x ‘versions’ of Antarctic crustal thickness grids.

version=’shen-2018’ Crustal thickness (excluding ice layer) from Shen et al.[49]. Accessed from https://sites.google.com/view/weisen/research-products?authuser=0

version=’an-2015’ Crustal thickness (distance from solid (ice and rock) top to Moho discontinuity) from An et al.[50]. Accessed from http://www.seismolab.org/model/antarctica/lithosphere/index.html#an1s File is the AN1-CRUST model, paper states “Moho depths and crustal thicknesses referred to below are the distance from the solid surface to the Moho. We note that this definition of Moho depth is different from that in the compilation of AN-MOHO”. Unclear, but seems moho depth is just negative of crustal thickness. Not sure if its to the ice surface or ice base.

Parameters:
  • version (str) – Either ‘shen-2018’, will add later: ‘lamb-2020’, ‘an-2015’, ‘baranov’, ‘chaput’, ‘crust1’, ‘szwillus’, ‘llubes’, ‘pappa’, ‘stal’

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (int, optional) – grid spacing to resample the loaded grid to, by default spacing is read from downloaded files

  • registration (str, optional) – change registration with either ‘p’ for pixel or ‘g’ for gridline registration, by default is None.

  • **kwargs (Any) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of crustal thickness.

Return type:

xarray.DataArray

References

moho(version, region=None, spacing=None, registration=None, **kwargs)[source]#

Load 1 of x ‘versions’ of Antarctic Moho depth grids.

version=’shen-2018’ Depth to the Moho relative to the surface of solid earth (bottom of ice/ocean) from Shen et al.[49]. Accessed from https://sites.google.com/view/weisen/research-products?authuser=0 Appears to be almost identical to crustal thickness from Shen et al. 2018

version=’an-2015’ This is fetch.crustal_thickness(version=’an-2015)* -1 Documentation is unclear whether the An crust model from An et al.[50] is crustal thickness or moho depths, or whether it makes a big enough difference to matter.

version=’pappa-2019’ from Pappa et al.[51]. Accessed from supplement material

Parameters:
  • version (str) – Either ‘shen-2018’, ‘an-2015’, ‘pappa-2019’, will add later: ‘lamb-2020’, ‘baranov’, ‘chaput’, ‘crust1’, ‘szwillus’, ‘llubes’,

  • region (tuple[float, float, float, float], optional) – region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by default doesn’t clip

  • spacing (int, optional) – grid spacing to resample the loaded grid to, by default spacing is read from downloaded files

  • registration (str, optional,) – choose between ‘g’ (gridline) or ‘p’ (pixel) registration types, by default is the original type of the grid

  • **kwargs (Any) – additional keyword arguments to pass to the resample_grid function

Returns:

Returns a loaded, and optional clip/resampled grid of crustal thickness.

Return type:

xarray.DataArray

References