GPlates Python documentation

PyGPlates enables access to GPlates functionality via the Python programming language.

This documentation includes:

• Introduction - introduces pyGPlates and covers some advantages over GPlates,
• Getting started - installation of pyGPlates and a tutorial to get you started using pyGPlates,
• Sample code - documented sample code solving common plate tectonic problems using pyGPlates,
• Foundations - plate tectonic foundations of pyGPlates,
• Reference - a detailed reference of pyGPlates functions and classes.

Contents

• Introduction
  • GPlates versus pyGPlates
  • Why use pyGPlates ?
  • External versus embedded pyGPlates
    • Using pyGPlates with an external Python interpreter
    • Using pyGPlates with the GPlates embedded Python interpreter
• Getting started
  • Installation
    • When to install pyGPlates
    • Installing pyGPlates
    • Telling Python how to find pyGPlates
    • Installing Python
    • Using the correct Python version
    • Miscellaneous issues
  • Tutorial
    • What are functions and classes ?
    • Introductory pyGPlates script
• Sample code
  • Import
    • Import geometries and assign plate IDs
  • Load/Save
    • Load and save feature collections
  • Create/query features
    • Create common feature types
    • Query common feature types
  • Reconstruct features
    • Reconstruct regular features
    • Reconstruct motion path features
    • Reconstruct flowline features
  • Rotations
    • Hierarchy of plate rotations
    • Plate circuits to anchored plate
    • Modify a reconstruction pole
  • Topologies
    • Find average area and subducting boundary proportion of topologies
    • Find the total length of ridges and subduction zones
    • Find gaps and overlaps in global topological boundaries
    • Create topological features
  • Velocities
    • Calculate velocities by plate ID
    • Calculate velocities in dynamic plates
  • Spatial proximity
    • Find nearest reconstructed feature to a point
    • Find reconstructed features overlapping a polygon
    • Find overriding plate of closest subducting line
  • Isochrons
    • Create conjugate isochrons from a ridge
    • Split an isochron into ridge and transform segments
• Foundations
  • Plate reconstruction hierarchy
  • Working with finite rotations
    • Composing finite rotations
    • Plate circuit paths
    • Equivalent total rotation
    • Relative total rotation
    • Equivalent stage rotation
    • Relative stage rotation
• Reference
  • Reconstruction
    • pygplates.reconstruct
    • pygplates.reverse_reconstruct
    • pygplates.ReconstructedFeatureGeometry
    • pygplates.ReconstructedFlowline
    • pygplates.ReconstructedMotionPath
    • pygplates.ReconstructionGeometry
  • Topology
    • pygplates.resolve_topologies
    • pygplates.ResolvedTopologicalLine
    • pygplates.ResolvedTopologicalBoundary
    • pygplates.ResolvedTopologicalNetwork
    • pygplates.ReconstructionGeometry
    • pygplates.ResolvedTopologicalSubSegment
    • pygplates.ResolvedTopologicalSection
    • pygplates.ResolvedTopologicalSharedSubSegment
  • Velocity
    • pygplates.calculate_velocities
  • Rotation
    • pygplates.RotationModel
    • pygplates.FiniteRotation
    • pygplates.ReconstructionTree
    • pygplates.ReconstructionTreeEdge
    • pygplates.find_crossovers
    • pygplates.synchronise_crossovers
  • Plate Partitioning
    • pygplates.partition_into_plates
    • pygplates.PlatePartitioner
  • File I/O
    • pygplates.FeatureCollection
    • pygplates.FeatureCollectionFileFormatRegistry
  • Feature
    • pygplates.Feature
    • pygplates.FeatureCollection
  • Feature property
    • pygplates.Property
    • pygplates.PropertyName
    • pygplates.PropertyValue
    • pygplates.PropertyValueVisitor
  • Feature property value
    • pygplates.Enumeration
    • pygplates.GmlDataBlock
    • pygplates.GmlLineString
    • pygplates.GmlMultiPoint
    • pygplates.GmlOrientableCurve
    • pygplates.GmlPoint
    • pygplates.GmlPolygon
    • pygplates.GmlTimeInstant
    • pygplates.GmlTimePeriod
    • pygplates.GpmlArray
    • pygplates.GpmlFiniteRotation
    • pygplates.GpmlKeyValueDictionary
    • pygplates.GpmlOldPlatesHeader
    • pygplates.GpmlPlateId
    • pygplates.GpmlPolarityChronId
    • pygplates.XsBoolean
    • pygplates.XsDouble
    • pygplates.XsInteger
    • pygplates.XsString
    • pygplates.GpmlTopologicalLine
    • pygplates.GpmlTopologicalPolygon
    • pygplates.GpmlTopologicalNetwork
    • pygplates.GpmlTopologicalSection
    • pygplates.GpmlTopologicalPoint
    • pygplates.GpmlTopologicalLineSection
    • pygplates.GpmlPropertyDelegate
    • pygplates.GpmlConstantValue
    • pygplates.GpmlIrregularSampling
    • pygplates.GpmlPiecewiseAggregation
    • pygplates.GpmlPropertyDelegateList
    • pygplates.GpmlTimeSample
    • pygplates.GpmlTimeSampleList
    • pygplates.GpmlTimeWindow
    • pygplates.GpmlTimeWindowList
    • pygplates.GpmlTopologicalSectionList
  • Geometry
    • pygplates.PointOnSphere
    • pygplates.MultiPointOnSphere
    • pygplates.PolylineOnSphere
    • pygplates.PolygonOnSphere
    • pygplates.GeometryOnSphere
    • pygplates.GreatCircleArc
    • pygplates.LatLonPoint
  • Vector
    • pygplates.LocalCartesian
    • pygplates.Vector3D
  • String
    • pygplates.EnumerationType
    • pygplates.FeatureId
    • pygplates.FeatureType
    • pygplates.PropertyName
    • pygplates.ScalarType
  • Utility
    • pygplates.DateLineWrapper
    • pygplates.Earth
    • pygplates.FeaturesFunctionArgument
    • pygplates.GeoTimeInstant
    • pygplates.Version

Indices and tables

• Index
• Module Index
• Search Page