gplately.PlateModel

class gplately.PlateModel(model_name: str, model_cfg=None, data_dir: str = '.', readonly=False, timeout=(None, None))

Bases: object

Download and manage files required for a plate reconstruction model.

👀👇 LOOK HERE!!! 👀👇

Normally you should always use PlateModelManager.get_model() to get a PlateModel object. Create a PlateModel object directly only when you don’t have Internet connection and would like to use the local model files in readonly mode. Do not create a PlateModel object directly if you have no idea what’s going on.

See also

Use PlateModel class in readonly mode.

__init__(model_name: str, model_cfg=None, data_dir: str = '.', readonly=False, timeout=(None, None))

Constructor. Create a PlateModel instance.

Parameters:

• model_name (str) – The model name of interest.

• model_cfg – The model configuration in JSON format. The configuration is either downloaded from the server or loaded from a local file .metadata.json. If you are confused by this parameter, use PlateModelManager.get_model() to get a PlateModel object instead.

• data_dir (str, default=".") – The folder path to save the model data.

• readonly (bool, default=False) – If this flag is set to True, The PlateModel object will use the files in the local folder and will not attempt to download/update the files from the server.

• timeout – Network connection timeout parameter.

Methods

__init__(model_name[, model_cfg, data_dir, ...])	Constructor.
create_model_dir()	Create a folder with a file .metadata.json in it to keep the model files.
download_all()	Download everything in this plate model.
download_all_layers()	Download all layers.
download_time_dependent_rasters(raster_name)	Download time-dependent rasters for a given raster name.
get_COBs([return_none_if_not_exist])	Return a list of Continent-Ocean Boundaries files.
get_avail_layers()	Get all available layers in this plate model.
get_avail_time_dependent_raster_names()	Return all time-dependent raster names in this plate model.
get_big_time()	The max (big number in Ma) reconstruction time in the model.
get_cfg()	Return the model configuration.
get_coastlines([return_none_if_not_exist])	Return a list of coastlines files.
get_continental_polygons([...])	Return a list of continental polygons files.
get_data_dir()	Return the path to a folder (parent folder of the model dir) containing a set of downloaded models.
get_layer(layer_name[, return_none_if_not_exist])	Get a list of layer files by a layer name.
get_model_dir()	Return the path to a folder containing the model files.
get_raster(raster_name, time)	Return a local path for the raster file.
get_rasters(raster_name, times)	Return local paths for the raster files.
get_rotation_model()	Return a list of rotation files.
get_small_time()	The min (small number in Ma) reconstruction time in the model.
get_static_polygons([return_none_if_not_exist])	Return a list of static polygons files.
get_topologies([return_none_if_not_exist])	Return a list of topologies files.
is_model_dir(folder_path)	Return True if the folder contains files of a plate model, otherwise False.
purge()	Remove the model folder and everything inside the folder.
purge_layer(layer_name)	Remove the layer folder of the given layer name.
purge_time_dependent_rasters(raster_name)	Remove the raster folder of the given raster name.
set_data_dir(new_dir)	Change the folder (parent folder of the model dir) in which you would like to save your model.

Attributes

model

The model metadata.

create_model_dir()

Create a folder with a file .metadata.json in it to keep the model files.

download_all()

Download everything in this plate model.

download_all_layers()

Download all layers. This function calls download_layer_files() on every available layer.

download_time_dependent_rasters(raster_name, times=None)

Download time-dependent rasters for a given raster name.

Call get_avail_time_dependent_raster_names() to see all the available raster names in this model.

Parameters:

• raster_name – the raster name of interest

• times – if not given, download from begin to end with 1My interval

get_COBs(return_none_if_not_exist: bool = False) → List[str] | None

Return a list of Continent-Ocean Boundaries files.

get_avail_layers()

Get all available layers in this plate model.

get_avail_time_dependent_raster_names()

Return all time-dependent raster names in this plate model.

get_big_time()

The max (big number in Ma) reconstruction time in the model.

get_cfg()

Return the model configuration.

get_coastlines(return_none_if_not_exist: bool = False) → List[str] | None

Return a list of coastlines files.

get_continental_polygons(return_none_if_not_exist: bool = False) → List[str] | None

Return a list of continental polygons files.

get_data_dir()

Return the path to a folder (parent folder of the model dir) containing a set of downloaded models.

get_layer(layer_name: str, return_none_if_not_exist: bool = False) → List[str] | None

Get a list of layer files by a layer name. Call get_avail_layers() to get all the available layer names.

Raise LayerNotFoundInModel exception to get user’s attention by default. Set return_none_if_not_exist to True if you don’t want to see the LayerNotFoundInModel exception.

Parameters:

• layer_name – The layer name of interest.

• return_none_if_not_exist – If set to True, return None when the layer does not exist in the model.

Returns:

A list of file names or None if return_none_if_not_exist is set to True.

:raises LayerNotFoundInModel: Raise this exception if the layer name does not exist in this model.

get_model_dir()

Return the path to a folder containing the model files.

get_raster(raster_name: str, time: int | float) → str

Return a local path for the raster file.

Parameters:

time (int or float) – A single time of interest.

Returns:

A local path of the raster file.

Return type:

str

get_rasters(raster_name: str, times: List[int | float]) → List[str]

Return local paths for the raster files.

Parameters:

times – A list of times

Returns:

A list of local paths

get_rotation_model()

Return a list of rotation files.

get_small_time()

The min (small number in Ma) reconstruction time in the model.

get_static_polygons(return_none_if_not_exist: bool = False) → List[str] | None

Return a list of static polygons files.

get_topologies(return_none_if_not_exist: bool = False) → List[str] | None

Return a list of topologies files.

static is_model_dir(folder_path: str)

Return True if the folder contains files of a plate model, otherwise False.

property model: Dict

The model metadata.

purge()

Remove the model folder and everything inside the folder.

purge_layer(layer_name)

Remove the layer folder of the given layer name.

purge_time_dependent_rasters(raster_name)

Remove the raster folder of the given raster name.

set_data_dir(new_dir)

Change the folder (parent folder of the model dir) in which you would like to save your model.