gplately.auxiliary

A set of helper functions designed to streamline the use of GPlately’s functionalities, minimizing the coding effort required from users.

Functions

`get_data_server_cache_path`()	Return the path to the `gplately.DataServer` cache as a `os.PathLike` object.
`get_gplot`(model, model_repo_dir, time, ...)	Return a `gplately.PlotTopologies` object for a given model name or `gplately.PlateModel` object.
`get_plate_reconstruction`(model[, ...])	Return a `gplately.PlateReconstruction` object for a given model name or `gplately.PlateModel` object.
`get_pygmt_basemap_figure`([projection, region])	A helper function to return a `pygmt.Figure()` object

gplately.auxiliary.get_data_server_cache_path()[source]: Return the path to the gplately.DataServer cache as a os.PathLike object.

See also

gplately.DataServer.cache_path

gplately.auxiliary.get_gplot(model: str | PlateModel, model_repo_dir: str = './', time: int | float = 0, plot_engine: PlotEngine = <gplately.mapping.cartopy_plot.CartopyPlotEngine object>, default_anchor_plate_id: int = 0) → PlotTopologies[source]

Return a gplately.PlotTopologies object for a given model name or gplately.PlateModel object.

Parameters:

model (str or PlateModel) – model name or a gplately.PlateModel object
model_repo_dir (str, default="./") – the folder in which you would like to keep the model files
time (int or float, default=0) – the reconstruction age/time
plot_engine (PlotEngine, default=CartopyPlotEngine()) – two choices - CartopyPlotEngine() or PygmtPlotEngine()
default_anchor_plate_id (int, default=0) – the default anchor plate ID to use to create pygplates.RotationModel.

Returns:

a gplately.PlotTopologies object

Return type:

PlotTopologies