.. _pygplates_sample_code:

Sample code
===========

This document contains sample code that shows pyGPlates solving common plate tectonic problems.

.. note:: The :ref:`pygplates_getting_started` section has a
   :ref:`Getting Started tutorial<pygplates_getting_started_tutorial>` as well as an
   :ref:`installation guide<pygplates_getting_started_installation>` to help get started.


.. contents::
   :local:
   :depth: 2

Import
------

This section covers how to get geometry data into a state where it can be reconstructed by pyGPlates.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_import_geometries_and_assign_plate_ids

Load/Save
---------

This section covers how to load and save collections of features from/to files.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_load_and_save_feature_collections

Create/query features
---------------------

This section covers how to create features from scratch and how to query their properties.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_create_common_feature_types
   sample-code/pygplates_query_common_feature_types

Reconstruct features
--------------------

This section covers how to reconstruct regular features, motion path features and flowline features
to past geological times.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_reconstruct_regular_features
   sample-code/pygplates_reconstruct_motion_path_features
   sample-code/pygplates_reconstruct_flowline_features

Rotations
---------

This section covers querying and modifying the rotations that are used to reconstruct features to
past geological times.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_plate_rotation_hierarchy
   sample-code/pygplates_plate_circuits_to_anchored_plate
   sample-code/pygplates_modify_reconstruction_pole

Topologies
----------

This section covers how to reconstruct (or resolve) dynamic geometries (such as topological plate boundaries)
at past geological times, and how to query their topologies.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_find_average_area_and_subducting_boundary_proportion_of_topologies
   sample-code/pygplates_find_total_ridge_and_subduction_zone_lengths
   sample-code/pygplates_detect_topology_gaps_and_overlaps
   sample-code/pygplates_reconstruct_crustal_thickness_and_tectonic_subsidence
   sample-code/pygplates_create_topological_features

Velocities
----------

This section covers how to calculate velocities of features as they move through geological time
and also how to calculate velocities of plates at non-moving point locations.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_calculate_velocities_by_plate_id
   sample-code/pygplates_calculate_velocities_in_dynamic_plates

Spatial proximity
-----------------

This section covers queries involving distances between geometries.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_find_nearest_feature_to_a_point
   sample-code/pygplates_find_features_overlapping_a_polygon
   sample-code/pygplates_find_overriding_plate_of_closest_subducting_line

.. seealso:: :ref:`pygplates_calculate_distance_a_feature_is_reconstructed`

Isochrons
---------

This section covers some use cases specific to the isochron feature type.

.. toctree::
   :maxdepth: 3

   sample-code/pygplates_create_conjugate_isochrons_from_ridge
   sample-code/pygplates_split_isochron_into_ridges_and_transforms