List of functions and classes (API)

Functions and variables used to download the datasets and cache them locally. Use the respective module to access the datasets in each major version of the data release.

Tip

The best way to use Ensaio is to import ensaio.v1 as ensaio or likewise with other versions that are available. This way your code will continue to work even when Ensaio updates to include newer incompatible dataset versions. See Version compatibility.

ensaio.v1

The datasets in the version 1 series.

Functions:

ensaio.v1.locate()

Return the location of the system-dependent data cache for v1 datasets

ensaio.v1.fetch_alps_gps()

Alpine 3-component GPS velocity dataset

ensaio.v1.fetch_britain_magnetic()

Digitized airborne magnetic survey of Britain

ensaio.v1.fetch_british_columbia_lidar()

Lidar point cloud data of the Trail Islands in BC, Canada

ensaio.v1.fetch_caribbean_bathymetry()

Single-beam bathymetry of the Caribbean

ensaio.v1.fetch_earth_geoid()

Geoid height of the Earth at 10 arc-minute resolution

ensaio.v1.fetch_earth_gravity()

Gravity of the Earth at 10 arc-minute resolution

ensaio.v1.fetch_earth_topography()

Topography of the Earth at 10 arc-minute resolution

ensaio.v1.fetch_southern_africa_gravity()

Gravity ground-based surveys of Southern Africa

Module variables:

ensaio.v1.DOI

The DOI of the source data archive on Zenodo

ensaio.v1.URL

The download URL of the source data release on GitHub (append a data file name to download it)

ensaio.v1.ENVIRONMENT_VARIABLE_URL

Environment variable used to specify the download URL (defaults to the DOI)

ensaio.v1.ENVIRONMENT_VARIABLE_CACHE

Environment variable used to specify the cache folder (defaults to ensaio/v1 in the system default cache)