add doc files for v1.0.0 v1.1.0 v1.3.0 dev-doc

GPlates · Jun 24, 2024 · 0712796 · 0712796
1 parent 93d7ed5
commit 0712796
Show file tree

Hide file tree

Showing 109 changed files with 268,773 additions and 0 deletions.
diff --git a/dev-doc/download.html b/dev-doc/download.html
diff --git a/dev-doc/geometry.html b/dev-doc/geometry.html
diff --git a/dev-doc/gpml.html b/dev-doc/gpml.html
diff --git a/dev-doc/grids.html b/dev-doc/grids.html
diff --git a/dev-doc/index.html b/dev-doc/index.html
diff --git a/dev-doc/oceans.html b/dev-doc/oceans.html
diff --git a/dev-doc/parallel.html b/dev-doc/parallel.html
diff --git a/dev-doc/plot.html b/dev-doc/plot.html
diff --git a/dev-doc/ptt/cleanup_topologies.html b/dev-doc/ptt/cleanup_topologies.html
diff --git a/dev-doc/ptt/continent_contours.html b/dev-doc/ptt/continent_contours.html
diff --git a/dev-doc/ptt/convert_xy_to_gplates.html b/dev-doc/ptt/convert_xy_to_gplates.html
diff --git a/dev-doc/ptt/diagnose_rotations.html b/dev-doc/ptt/diagnose_rotations.html
diff --git a/dev-doc/ptt/documentation.html b/dev-doc/ptt/documentation.html
@@ -0,0 +1,124 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.8.1" />
+<title>gplately.ptt.documentation API documentation</title>
+<meta name="description" content="" />
+<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
+<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
+<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
+<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script async src='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS_CHTML'></script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>gplately.ptt.documentation</code></h1>
+</header>
+<section id="section-intro">
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">import pkg_resources as _pkg_resources
+from distutils import dir_util as _dir_util
+import os
+
+
+def install_documentation(path=&#34;./PlateTectonicTools-Examples&#34;):
+    &#34;&#34;&#34;
+    Install the examples for PlateTectonicTools in the given location.
+
+    WARNING: If the path exists, the files will be written into the path
+    and will overwrite any existing files with which they collide. The default
+    path (&#34;./PlateTectonicTools-Examples&#34;) is chosen to make collision less likely/problematic
+
+    The documentation for PlateTectonicTools is in the form of jupyter notebooks.
+    &#34;&#34;&#34;
+
+    Notebooks_Path = _pkg_resources.resource_filename(&#34;ptt&#34;, os.path.join(&#34;Examples&#34;))
+
+    ct = _dir_util.copy_tree(Notebooks_Path, path, preserve_mode=1, preserve_times=1, preserve_symlinks=1, update=0, verbose=1, dry_run=0)
+
+    return</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="gplately.ptt.documentation.install_documentation"><code class="name flex">
+<span>def <span class="ident">install_documentation</span></span>(<span>path='./PlateTectonicTools-Examples')</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Install the examples for PlateTectonicTools in the given location.</p>
+<p>WARNING: If the path exists, the files will be written into the path
+and will overwrite any existing files with which they collide. The default
+path ("./PlateTectonicTools-Examples") is chosen to make collision less likely/problematic</p>
+<p>The documentation for PlateTectonicTools is in the form of jupyter notebooks.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def install_documentation(path=&#34;./PlateTectonicTools-Examples&#34;):
+    &#34;&#34;&#34;
+    Install the examples for PlateTectonicTools in the given location.
+
+    WARNING: If the path exists, the files will be written into the path
+    and will overwrite any existing files with which they collide. The default
+    path (&#34;./PlateTectonicTools-Examples&#34;) is chosen to make collision less likely/problematic
+
+    The documentation for PlateTectonicTools is in the form of jupyter notebooks.
+    &#34;&#34;&#34;
+
+    Notebooks_Path = _pkg_resources.resource_filename(&#34;ptt&#34;, os.path.join(&#34;Examples&#34;))
+
+    ct = _dir_util.copy_tree(Notebooks_Path, path, preserve_mode=1, preserve_times=1, preserve_symlinks=1, update=0, verbose=1, dry_run=0)
+
+    return</code></pre>
+</details>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<header>
+<a class="homelink" rel="home" title="GPlately Home" href="https://gplates.github.io/gplately/">
+<img src="https://raw.githubusercontent.com/GPlates/gplately/master/Notebooks/NotebookFiles/ReadMe_Files/GPlately_Main_logo.png" alt="GPlately logo" height="172" width="205">
+</a>
+</header>
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="gplately.ptt" href="index.html">gplately.ptt</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="gplately.ptt.documentation.install_documentation" href="#gplately.ptt.documentation.install_documentation">install_documentation</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.8.1</a>.</p>
+</footer>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+<script>hljs.initHighlightingOnLoad()</script>
+</body>
+</html>