Skip to content

Commit

Permalink
update web doc
Browse files Browse the repository at this point in the history
Minor text update to the web documentation
  • Loading branch information
AB-Ares committed Jul 24, 2021
1 parent d58a01e commit e3b5761
Show file tree
Hide file tree
Showing 29 changed files with 61 additions and 40 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/examples.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/installation.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/references.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/source/Displacement_strain_planet.doctree
Binary file not shown.
7 changes: 5 additions & 2 deletions docs/_build/html/_sources/examples.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,19 @@ Mars
----

``Mars_crust_displacement.py``
A script that demonstrates how to calculate the moho-relief on Mars using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions associated with the displacement.
A script that demonstrates how to calculate the moho-relief on Mars using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions given the estimated displacement.

``Mars_SouthPolarCap_displacement.py``
A script that demonstrates how to calculate iteratively the flexure underneath the south polar cap of Mars as a function of elastic thickness and ice density. This computation is similar to that done in e.g., Broquet et al. (2021), in review to JGR:Planets.

``Run_demo.ipynb`` |ImageLink|_
A jupyter notebook that shows many of the functionalities of Displacement_strain_planet using Mars as an example: moho-relief calculations under various assumptions, including Airy or Pratt isostasy, displacement calculations due to a mantle plume underneath Tharsis or due to internal loading in phase with the surface topography, strain calculations.

Venus
------

``Venus_crust_displacement.py``
A script that demonstrates how to calculate the moho-relief on Venus using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions associated with the displacement.
A script that demonstrates how to calculate the moho-relief on Venus using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions given the estimated displacement.

.. |ImageLink| image:: ../misc/link1.svg
:width: 20
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Displacement_strain_planet

Displacement_strain_planet provides several functions and example scripts for generating crustal thickness, displacement, gravity, lateral density variations, stress, and strain maps on a planet given a set of input constraints such as from observed gravity and topography data.

These functions solve the `Banerdt (1986) <https://agupubs.onlinelibrary.wiley.com/doi/10.1029/JB091iB01p00403>`_ system of equations under different assumptions. The model links 8 parameters: the topography, geoid at the surface, geoid at the moho depth, net acting load on the lithosphere, tangential load potential, flexure of the lithosphere, crustal thickness variations, and internal density variations. Minor corrections have been made in the geoid equations, through 5 equations. All is required is that the user specifies 3 constraints and the model will solve for all other parameters.
These functions solve the `Banerdt (1986) <https://agupubs.onlinelibrary.wiley.com/doi/10.1029/JB091iB01p00403>`_ system of equations under different assumptions. The model links 8 parameters: the topography, geoid at the surface, geoid at the moho depth, net acting load on the lithosphere, tangential load potential, flexure of the lithosphere, crustal thickness variations, and internal density variations, through 5 equations. Minor corrections have been made to the geoid equations and displacement equations following `Beuthe (2008) <https://onlinelibrary.wiley.com/doi/abs/10.1111/j.1365-246X.2007.03671.x>`_. All is required is that the user specifies 3 constraints and the model will solve for all other parameters.

Various improvements have been made to the model including the possibility to account for finite-amplitude correction and filtering `(Wieczorek & Phillips, 1998) <https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/97JE03136>`_, lateral density variations at any arbitrary depth and within the surface or moho-relief `(Wieczorek et al., 2013) <https://science.sciencemag.org/content/339/6120/671>`_, and density difference between the surface topography and crust `(Broquet & Wieczorek, 2019) <https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2019JE005959>`_.
Various improvements have been made to the model, including the possibility to account for finite-amplitude correction and filtering `(Wieczorek & Phillips, 1998) <https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/97JE03136>`_, lateral density variations at any arbitrary depth and within the surface or moho-relief `(Wieczorek et al., 2013) <https://science.sciencemag.org/content/339/6120/671>`_, and density difference between the surface topography and crust `(Broquet & Wieczorek, 2019) <https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2019JE005959>`_.

This routine has many applications and is highly versatile, and you can for example:

Expand All @@ -35,4 +35,4 @@ This routine has many applications and is highly versatile, and you can for exam

* Compute Legendre polynomial first and second order derivatives.

In addition to these functions, an example script is provided that will solve for the moho-relief on Mars and estimate the principal strains on the planet as a function of the input elastic thickness. A jupyter notebook is also added with more information on estimating the moho-relief on Mars, assuming Airy or Pratt isostasy, the displacement due to a mantle plume underneath Tharsis or due to internal loading in phase with the surface topography.
In addition to these functions, two example scripts are provided and will solve for the moho-relief on Mars & Venus, and estimate the principal strains on each planets as a function of the input elastic thickness. A jupyter notebook is also added with more information on estimating the moho-relief on Mars, assuming Airy or Pratt isostasy, the displacement due to a mantle plume underneath Tharsis or due to internal loading in phase with the surface topography.
2 changes: 2 additions & 0 deletions docs/_build/html/_sources/references.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ doi:\ `10.1029/JB091iB01p00403 <https://agupubs.onlinelibrary.wiley.com/doi/10.1
Broquet, A. and M. A. Wieczorek (2019). The Gravitational signature of Martian volcanoes. *Journal of Geophysical Research: Planets*, 124.8, pp. 2054–2086,
doi:\ `10.1029/2019JE005959 <https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2019JE005959>`__.

Beuthe, M. (2008). Thin elastic shells with variable thickness for lithospheric flexure of one-plate planets. *Geophysical Journal International*, 172.2, pp. 817–841, doi:\ `10.1111/j.1365-246X.2007.03671.x <https://onlinelibrary.wiley.com/doi/abs/10.1111/j.1365-246X.2007.03671.x>`__.

Knapmeyer, M. et al. (2006). Working models for spatial distribution and level of Mars’ seismicity. *Journal of Geophysical Research*, 111.E11006,
doi:\ `10.1029/2006JE002708 <https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2006JE002708>`__.

Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,7 @@ div.code-block-caption code {

table.highlighttable td.linenos,
span.linenos,
div.highlight span.gp { /* gp: Generic.Prompt */
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
Expand Down
2 changes: 0 additions & 2 deletions docs/_build/html/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -301,14 +301,12 @@ var Documentation = {
window.location.href = prevHref;
return false;
}
break;
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
}
}
});
Expand Down
8 changes: 7 additions & 1 deletion docs/_build/html/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ var Search = {
setTimeout(function() {
displayNextItem();
}, 5);
} else {
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: requestUrl,
dataType: "text",
complete: function(jqxhr, textstatus) {
Expand All @@ -289,6 +289,12 @@ var Search = {
displayNextItem();
}, 5);
}});
} else {
// no source available, just display title
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
}, 5);
}
}
// search finished, update title and status message
Expand Down
14 changes: 10 additions & 4 deletions docs/_build/html/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,16 +94,17 @@



<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#mars">Mars</a></li>
<li class="toctree-l2"><a class="reference internal" href="#venus">Venus</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference Documentation</span></p>
<p class="caption"><span class="caption-text">Reference Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/Displacement_strain_planet.html">Displacement_strain_planet package</a></li>
</ul>
Expand Down Expand Up @@ -180,13 +181,18 @@ <h1>Examples<a class="headerlink" href="#examples" title="Permalink to this head
<div class="section" id="mars">
<h2>Mars<a class="headerlink" href="#mars" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">Mars_crust_displacement.py</span></code></dt><dd><p>A script that demonstrates how to calculate the moho-relief on Mars using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions associated with the displacement.</p>
<dt><code class="docutils literal notranslate"><span class="pre">Mars_crust_displacement.py</span></code></dt><dd><p>A script that demonstrates how to calculate the moho-relief on Mars using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions given the estimated displacement.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Mars_SouthPolarCap_displacement.py</span></code></dt><dd><p>A script that demonstrates how to calculate iteratively the flexure underneath the south polar cap of Mars as a function of elastic thickness and ice density. This computation is similar to that done in e.g., Broquet et al. (2021), in review to JGR:Planets.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Run_demo.ipynb</span></code> <a class="reference external" href="notebooks/Run_demo.html"><img alt="ImageLink" src="_images/link1.svg" width="20" /></a></dt><dd><p>A jupyter notebook that shows many of the functionalities of Displacement_strain_planet using Mars as an example: moho-relief calculations under various assumptions, including Airy or Pratt isostasy, displacement calculations due to a mantle plume underneath Tharsis or due to internal loading in phase with the surface topography, strain calculations.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Venus_crust_displacement.py</span></code></dt><dd><p>A script that demonstrates how to calculate the moho-relief on Venus using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions associated with the displacement.</p>
</dl>
</div>
<div class="section" id="venus">
<h2>Venus<a class="headerlink" href="#venus" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">Venus_crust_displacement.py</span></code></dt><dd><p>A script that demonstrates how to calculate the moho-relief on Venus using global gravity and topography data. The moho relief is splited in an isostatic part and a displacement part, which depends on the elastic thickness of the lithosphere. The script then computes the principal horizontal strains and their directions given the estimated displacement.</p>
</dd>
</dl>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,13 @@



<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference Documentation</span></p>
<p class="caption"><span class="caption-text">Reference Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/Displacement_strain_planet.html">Displacement_strain_planet package</a></li>
</ul>
Expand Down
10 changes: 5 additions & 5 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,13 @@



<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference Documentation</span></p>
<p class="caption"><span class="caption-text">Reference Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/Displacement_strain_planet.html">Displacement_strain_planet package</a></li>
</ul>
Expand Down Expand Up @@ -174,8 +174,8 @@
<div class="section" id="displacement-strain-planet">
<h1>Displacement_strain_planet<a class="headerlink" href="#displacement-strain-planet" title="Permalink to this headline"></a></h1>
<p>Displacement_strain_planet provides several functions and example scripts for generating crustal thickness, displacement, gravity, lateral density variations, stress, and strain maps on a planet given a set of input constraints such as from observed gravity and topography data.</p>
<p>These functions solve the <a class="reference external" href="https://agupubs.onlinelibrary.wiley.com/doi/10.1029/JB091iB01p00403">Banerdt (1986)</a> system of equations under different assumptions. The model links 8 parameters: the topography, geoid at the surface, geoid at the moho depth, net acting load on the lithosphere, tangential load potential, flexure of the lithosphere, crustal thickness variations, and internal density variations. Minor corrections have been made in the geoid equations, through 5 equations. All is required is that the user specifies 3 constraints and the model will solve for all other parameters.</p>
<p>Various improvements have been made to the model including the possibility to account for finite-amplitude correction and filtering <a class="reference external" href="https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/97JE03136">(Wieczorek &amp; Phillips, 1998)</a>, lateral density variations at any arbitrary depth and within the surface or moho-relief <a class="reference external" href="https://science.sciencemag.org/content/339/6120/671">(Wieczorek et al., 2013)</a>, and density difference between the surface topography and crust <a class="reference external" href="https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2019JE005959">(Broquet &amp; Wieczorek, 2019)</a>.</p>
<p>These functions solve the <a class="reference external" href="https://agupubs.onlinelibrary.wiley.com/doi/10.1029/JB091iB01p00403">Banerdt (1986)</a> system of equations under different assumptions. The model links 8 parameters: the topography, geoid at the surface, geoid at the moho depth, net acting load on the lithosphere, tangential load potential, flexure of the lithosphere, crustal thickness variations, and internal density variations, through 5 equations. Minor corrections have been made to the geoid equations and displacement equations following <a class="reference external" href="https://onlinelibrary.wiley.com/doi/abs/10.1111/j.1365-246X.2007.03671.x">Beuthe (2008)</a>. All is required is that the user specifies 3 constraints and the model will solve for all other parameters.</p>
<p>Various improvements have been made to the model, including the possibility to account for finite-amplitude correction and filtering <a class="reference external" href="https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/97JE03136">(Wieczorek &amp; Phillips, 1998)</a>, lateral density variations at any arbitrary depth and within the surface or moho-relief <a class="reference external" href="https://science.sciencemag.org/content/339/6120/671">(Wieczorek et al., 2013)</a>, and density difference between the surface topography and crust <a class="reference external" href="https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2019JE005959">(Broquet &amp; Wieczorek, 2019)</a>.</p>
<p>This routine has many applications and is highly versatile, and you can for example:</p>
<ul class="simple">
<li><p>Compute the relief along the crust-mantle interface based on the input constraints (3 constraints are required, e.g., 1. and 2. the model should match the observed gravity and topography of the planet 3. there are no lateral variations in density).</p></li>
Expand All @@ -184,7 +184,7 @@ <h1>Displacement_strain_planet<a class="headerlink" href="#displacement-strain-p
<li><p>Compute the associated strain and stresses and determine their principal horizontal components and directions.</p></li>
<li><p>Compute Legendre polynomial first and second order derivatives.</p></li>
</ul>
<p>In addition to these functions, an example script is provided that will solve for the moho-relief on Mars and estimate the principal strains on the planet as a function of the input elastic thickness. A jupyter notebook is also added with more information on estimating the moho-relief on Mars, assuming Airy or Pratt isostasy, the displacement due to a mantle plume underneath Tharsis or due to internal loading in phase with the surface topography.</p>
<p>In addition to these functions, two example scripts are provided and will solve for the moho-relief on Mars &amp; Venus, and estimate the principal strains on each planets as a function of the input elastic thickness. A jupyter notebook is also added with more information on estimating the moho-relief on Mars, assuming Airy or Pratt isostasy, the displacement due to a mantle plume underneath Tharsis or due to internal loading in phase with the surface topography.</p>
</div>


Expand Down
Loading

0 comments on commit e3b5761

Please sign in to comment.