Deploying to gh-pages from @ 4946020 🚀

dev-doc/tools.html

@@ -228,6 +228,35 @@ <h2 id="raises">Raises</h2>
 <div class="desc"><p>Determine the present-day plate ID of a (lat, lon) coordinate pair if
 it is not specified.</p></div>
 </dd>
+<dt id="gplately.tools.plate_surface_depth"><code class="name flex">
+<span>def <span class="ident">plate_surface_depth</span></span>(<span>age, model='Richards2020')</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Computes the depth to the surface of a cooling plate.</p>
+<p>Essentially converts the ocean basin age to basement depth using a specified age/depth model.</p>
+<h2 id="parameters">Parameters</h2>
+<dl>
+<dt><strong><code>age</code></strong> :&ensp;<code>float</code></dt>
+<dd>The age in Ma.</dd>
+<dt><strong><code>model</code></strong> :&ensp;<code>str</code></dt>
+<dd>The model to use when converting ocean age to basement depth.
+- 'Richards2020': Richards et al. (2020), Structure and dynamics of the oceanic lithosphere-asthenosphere system
+- 'Stein1992': Stein and Stein (1992), Model for the global variation in oceanic depth and heat flow with lithospheric age
+- 'Parsons1977': Parsons and Sclater (1972), An analysis of the variation of ocean floor bathymetry and heat flow with age</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><strong><code>depth</code></strong> :&ensp;<code>array</code></dt>
+<dd>Depth (in metres) as a positive number.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>ValueError</code></dt>
+<dd>If <code>model</code> is not a recognised model.</dd>
+</dl>
+<h2 id="notes">Notes</h2>
+<p>The Richards2020 curve is approximate. A polynomial was fitted to the age-depth data</p></div>
+</dd>
 <dt id="gplately.tools.plate_temp"><code class="name flex">
 <span>def <span class="ident">plate_temp</span></span>(<span>age, z, plate_thickness=125000.0, kappa=8.04e-07, t_mantle=1350.0, t_surface=0.0)</span>
 </code></dt>
@@ -406,6 +435,7 @@ <h2 id="notes">Notes</h2>
 <li><code><a title="gplately.tools.lonlat2xyz" href="#gplately.tools.lonlat2xyz">lonlat2xyz</a></code></li>
 <li><code><a title="gplately.tools.plate_isotherm_depth" href="#gplately.tools.plate_isotherm_depth">plate_isotherm_depth</a></code></li>
 <li><code><a title="gplately.tools.plate_partitioner_for_point" href="#gplately.tools.plate_partitioner_for_point">plate_partitioner_for_point</a></code></li>
+<li><code><a title="gplately.tools.plate_surface_depth" href="#gplately.tools.plate_surface_depth">plate_surface_depth</a></code></li>
 <li><code><a title="gplately.tools.plate_temp" href="#gplately.tools.plate_temp">plate_temp</a></code></li>
 <li><code><a title="gplately.tools.points_to_features" href="#gplately.tools.points_to_features">points_to_features</a></code></li>
 <li><code><a title="gplately.tools.read_csv" href="#gplately.tools.read_csv">read_csv</a></code></li>