Globe

Globe is a class that contains data and methods for to characterise the global geodynamic state of a reconstruction. In the PlateTorques module, the Globe class is used to store the plates of the model and to store the torques acting on the plates.

class plato.globe.Globe(settings=None, reconstruction=None, rotation_file=None, topology_file=None, polygon_file=None, reconstruction_name=None, ages=None, cases_file=None, cases_sheet='Sheet1', files_dir=None, plates=None, points=None, slabs=None, PARALLEL_MODE=False, DEBUG_MODE=False, CALCULATE_VELOCITIES=True, VERSION=1)[source]

Bases: object

Class to store information on global plate tectonic properties of the Earth.

A Globe object can be initialised in multiple ways:

  1. The user can initialise a Globe object from scratch by providing the reconstruction and the ages of interest. The reconstruction can be provided as a file with rotation poles, a file with topologies, and a file with polygons, or as one of the model name string identifiers for the models available on the GPlately DataServer (https://gplates.github.io/gplately/v1.3.0/#dataserver).

    Additionally, the user may specify the excel file with a number of different cases (combinations of options) to be considered.

  2. Alternatively, the user can initialise a Globe object by providing a Settings object and a Reconstruction object from a Globe, Grids, Plates, Points or Slabs object. Providing the settings from a Globe object will allow the user to initialise a new Globe object with the same settings as the original object.

Parameters:

  • settings (plato.settings.Settings) – Settings object (default: None)

  • reconstruction (gplately.PlateReconstruction) – Reconstruction object (default: None)

  • rotation_file (str) – filepath to .rot file with rotation poles (default: None)

  • topology_file (str) – filepath to .gpml file with topologies (default: None)

  • polygon_file (str) – filepath to .gpml file with polygons (default: None)

  • reconstruction_name (str) – model name string identifiers for the GPlately DataServer (default: None)

  • ages (float, int, list, numpy.ndarray) – ages of interest (default: None)

  • cases_file (str) – filepath to excel file with cases (default: None)

  • cases_sheet (str) – name of the sheet in the excel file with cases (default: “Sheet1”)

  • files_dir (str) – directory to store files (default: None)

  • PARALLEL_MODE (bool) – flag to enable parallel mode (default: False)

  • DEBUG_MODE (bool) – flag to enable debug mode (default: False)

  • CALCULATE_VELOCITIES (bool) – flag to calculate velocities (default: True)

calculate_number_of_plates(plates=None, ages=None, cases=None)[source]

Calculate the number of plates for each time step.

calculate_subduction_length(slabs=None, ages=None, cases=None)[source]

Calculate the subduction length for each time step.

calculate_net_rotation(plates=None, points=None, ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True, VERSION=1)[source]

Calculate the net rotation of the Earth’s lithosphere.

Parameters:

  • plates (plato.plates.Plates) – Plates object (default: None)

  • points (plato.points.Points) – Points object (default: None)

  • ages (float, int, list, numpy.ndarray) – ages of interest (default: None)

  • cases (str, list) – cases of interest (default: None)

  • plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

  • PROGRESS_BAR (bool) – flag to enable progress bar (default: True)

calculate_trench_migration(slabs=None, ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]

Calculate the net migration of the Earth’s subduction zones.

Parameters:

  • slabs (plato.slabs.Slabs) – Plates object (default: None)

  • points (plato.points.Points) – Points object (default: None)

  • ages (float, int, list, numpy.ndarray) – ages of interest (default: None)

  • cases (str, list) – cases of interest (default: None)

  • plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

  • PROGRESS_BAR (bool) – flag to enable progress bar (default: True)

calculate_world_uncertainty(ages=None, reconstructed_polygons=None)[source]

Calculate the fraction of the Earth’s surface that has been lost to subduction.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)

save(cases=None, file_dir=None, PROGRESS_BAR=True)[source]

Function to save ‘Globe’ object. Data of the ‘Globe’ object is saved to .parquet files.

Parameters:

  • cases (str, list) – cases of interest (default: None)

  • file_dir (str) – directory to store files (default: None)

  • PROGRESS_BAR (bool) – flag to enable progress bar (default: True)

export(cases=None, file_dir=None, PROGRESS_BAR=True)[source]

Function to export ‘Globe’ object. Data of the ‘Globe’ object is exported to .csv files.

Parameters:

  • cases (str, list) – cases of interest (default: None)

  • file_dir (str) – directory to store files (default: None)

  • PROGRESS_BAR (bool) – flag to enable progress bar (default: True)