API Reference

Gravity Corrections

bouguer_correction(topography[, …])

Gravitational effect of topography using a Bouguer plate approximation

For the Normal Earth correction, see package boule.

Equivalent Layers

EquivalentSources([damping, points, depth, …])

Equivalent sources for generic harmonic functions (gravity, magnetics).

EquivalentSourcesSph([damping, points, …])

Equivalent sources for generic harmonic functions in spherical coordinates

Forward modelling

point_mass_gravity(coordinates, points, …)

Compute gravitational fields of point masses.

prism_gravity(coordinates, prisms, density, …)

Gravitational fields of right-rectangular prisms in Cartesian coordinates

tesseroid_gravity(coordinates, tesseroids, …)

Compute gravitational field of tesseroids on computation points.

prism_layer(coordinates, surface, reference)

Create a layer of prisms of equal size

DatasetAccessorPrismLayer(xarray_obj)

Defines dataset accessor for layer of prisms

Isostasy

isostasy_airy(topography[, density_crust, …])

Calculate the isostatic Moho depth from topography using Airy’s hypothesis.

Input and Output

load_icgem_gdf(fname, **kwargs)

Reads data from an ICGEM .gdf file.

Synthetic models and surveys

synthetic.airborne_survey([region, data_region])

Create measurement locations for a synthetic airborne survey

synthetic.ground_survey([region, data_region])

Create measurement locations for a synthetic ground survey

Datasets

datasets.locate()

The absolute path to the sample data storage location on disk.

datasets.fetch_gravity_earth()

Fetch a global grid of Earth gravity.

datasets.fetch_geoid_earth()

Fetch a global grid of the geoid height.

datasets.fetch_topography_earth()

Fetch a global grid of Earth relief (topography and bathymetry).

datasets.fetch_britain_magnetic()

Fetch total-field magnetic anomaly data of Great Britain.

datasets.fetch_south_africa_gravity()

Fetch gravity station data from South Africa

Utilities

test([doctest, verbose, coverage, figures])

Run the test suite.