Updated docs

cmeessen · Jul 16, 2019 · a29a6c7 · a29a6c7
1 parent 66676da
commit a29a6c7
Show file tree

Hide file tree

Showing 83 changed files with 20,387 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: d0902875aed9cbed4d988f562e0f80e9
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_images/fig_bd_thickness.png b/docs/_images/fig_bd_thickness.png
diff --git a/docs/_images/plot_elastic_thickness.png b/docs/_images/plot_elastic_thickness.png
diff --git a/docs/_images/plot_integrated_strength.png b/docs/_images/plot_integrated_strength.png
diff --git a/docs/_images/plot_profile_refined.png b/docs/_images/plot_profile_refined.png
diff --git a/docs/_images/plot_profile_temperature.png b/docs/_images/plot_profile_temperature.png
diff --git a/docs/_images/plot_surface_heat_flow.png b/docs/_images/plot_surface_heat_flow.png
diff --git a/docs/_images/plot_topography.png b/docs/_images/plot_topography.png
diff --git a/docs/_images/plot_yse.png b/docs/_images/plot_yse.png
diff --git a/docs/_images/plot_yse_extension.png b/docs/_images/plot_yse_extension.png
diff --git a/docs/_images/well.png b/docs/_images/well.png
diff --git a/docs/_images/yse_profile.png b/docs/_images/yse_profile.png
diff --git a/docs/_images/yse_profile_competent.png b/docs/_images/yse_profile_competent.png
diff --git a/docs/_sources/api_reference.rst.txt b/docs/_sources/api_reference.rst.txt
@@ -0,0 +1,70 @@
+.. _api:
+
+API
+===
+
+This page is a summary of the most important classes and methods of
+:mod:`pyGMS`. For a full list of modules please refer to the :ref:`modindex`.
+
+Classes
+-------
+
+The classes of pyGMS are:
+
+.. currentmodule:: pyGMS.structures
+
+.. autosummary::
+
+    GMS
+    Well
+    Layer
+
+Computing methods
+-----------------
+
+Thermal field
+~~~~~~~~~~~~~
+
+.. autosummary::
+
+    GMS.compute_surface_heat_flow
+
+Rheology
+~~~~~~~~
+
+.. autosummary::
+
+    GMS.compute_bd_thickness
+    GMS.compute_elastic_thickness
+    GMS.compute_integrated_strength
+    GMS.compute_yse
+
+Visualisation
+-------------
+
+Profiles
+~~~~~~~~
+
+.. autosummary::
+
+    GMS.plot_profile
+    GMS.plot_layer_bounds
+    GMS.plot_strength_profile
+    GMS.plot_strength_profile
+    GMS.plot_yse
+
+Maps
+~~~~
+
+.. autosummary::
+
+    GMS.plot_topography
+    GMS.plot_surface_heat_flow
+
+Wells
+~~~~~
+
+.. autosummary::
+
+    Well.plot_var
+    Well.plot_grad
diff --git a/docs/_sources/changelog.rst.txt b/docs/_sources/changelog.rst.txt
@@ -0,0 +1 @@
+.. mdinclude:: ../../../CHANGELOG