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 Sources

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

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

EquivalentSourcesGB([damping, points, …])

Gradient-boosted equivalent sources for generic harmonic functions.

EquivalentSourcesSph([damping, points, …])

Equivalent sources for generic harmonic functions in spherical coordinates

Forward modelling

point_gravity(coordinates, points, masses, field)

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


Defines dataset accessor for layer of prisms


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



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


Fetch a global grid of Earth gravity.


Fetch a global grid of the geoid height.


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


Fetch total-field magnetic anomaly data of Great Britain.


Fetch gravity station data from South Africa


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

Run the test suite.