Skip to content

Commit 56ba146

Browse files
Update documentation
1 parent 86d0932 commit 56ba146

22 files changed

+199
-130
lines changed
34.4 KB
Loading
372 KB
Loading
284 KB
Loading

_sources/user_guide/quick_start.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
______________________________________________________________________
2-
3-
## file_format: mystnb kernelspec: name: python3
1+
---
2+
file_format: mystnb
3+
kernelspec:
4+
name: python3
5+
---
46

57
# Quick Start for Users
68

_sources/user_guide/wrapping.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
______________________________________________________________________
2-
3-
## file_format: mystnb kernelspec: name: python3
1+
---
2+
file_format: mystnb
3+
kernelspec:
4+
name: python3
5+
---
46

57
# Periodic Mesh Support
68

@@ -23,12 +25,13 @@ across the periodic boundary. The end product of both correcting and mirroring
2325
periodic patches is a fully periodic plot as demonstrated below:
2426

2527
```{code-cell} ipython3
26-
:tags: [hide-input]
27-
:mystnb:
28-
: code_prompt_show: "Source code to generate figure below"
29-
: code_prompt_hide: "Source code to generate figure below"
30-
: figure: {figure : center}
31-
28+
---
29+
tags: [hide-input]
30+
mystnb:
31+
code_prompt_show: Source code to generate figure below
32+
code_prompt_hide: Source code to generate figure below
33+
figure: {figure: center}
34+
---
3235
import mosaic
3336
import matplotlib.pyplot as plt
3437
@@ -76,12 +79,9 @@ Currently, the only support map projection for spherical meshes are:
7679
- <inv:#*.NorthPolarStereo>
7780
- <inv:#*.SouthPolarStereo>
7881

79-
:::{Note}
80-
:class: myclass1 myclass2
81-
:name: planar-non-periodic-note
82-
82+
```{Note}
8383
This subset of supported project only applies to spherical meshes.
8484
Planar (non-periodic) meshes are not limited to this list and can choose from
8585
the full range of `cartopy`
8686
[projections](https://scitools.org.uk/cartopy/docs/latest/reference/projections.html).
87-
:::
87+
```

developers_guide/api.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,8 @@
154154
<div class="bd-toc-item navbar-nav active">
155155
<p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
156156
<ul class="nav bd-sidenav">
157-
<li class="toctree-l1"><a class="reference internal" href="../user_guide/quick_start.html">file_format: mystnb kernelspec: name: python3</a></li>
158-
159-
<li class="toctree-l1"><a class="reference internal" href="../user_guide/wrapping.html">file_format: mystnb kernelspec: name: python3</a></li>
160-
157+
<li class="toctree-l1"><a class="reference internal" href="../user_guide/quick_start.html">Quick Start for Users</a></li>
158+
<li class="toctree-l1"><a class="reference internal" href="../user_guide/wrapping.html">Periodic Mesh Support</a></li>
161159
</ul>
162160
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Developers Guide:</span></p>
163161
<ul class="current nav bd-sidenav">

developers_guide/generated/mosaic.Descriptor.cell_patches.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,8 @@
154154
<div class="bd-toc-item navbar-nav active">
155155
<p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
156156
<ul class="nav bd-sidenav">
157-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">file_format: mystnb kernelspec: name: python3</a></li>
158-
159-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">file_format: mystnb kernelspec: name: python3</a></li>
160-
157+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">Quick Start for Users</a></li>
158+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">Periodic Mesh Support</a></li>
161159
</ul>
162160
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Developers Guide:</span></p>
163161
<ul class="nav bd-sidenav">

developers_guide/generated/mosaic.Descriptor.edge_patches.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,8 @@
154154
<div class="bd-toc-item navbar-nav active">
155155
<p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
156156
<ul class="nav bd-sidenav">
157-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">file_format: mystnb kernelspec: name: python3</a></li>
158-
159-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">file_format: mystnb kernelspec: name: python3</a></li>
160-
157+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">Quick Start for Users</a></li>
158+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">Periodic Mesh Support</a></li>
161159
</ul>
162160
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Developers Guide:</span></p>
163161
<ul class="nav bd-sidenav">

developers_guide/generated/mosaic.Descriptor.html

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,8 @@
154154
<div class="bd-toc-item navbar-nav active">
155155
<p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
156156
<ul class="nav bd-sidenav">
157-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">file_format: mystnb kernelspec: name: python3</a></li>
158-
159-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">file_format: mystnb kernelspec: name: python3</a></li>
160-
157+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">Quick Start for Users</a></li>
158+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">Periodic Mesh Support</a></li>
161159
</ul>
162160
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Developers Guide:</span></p>
163161
<ul class="nav bd-sidenav">
@@ -353,9 +351,9 @@ <h1>mosaic.Descriptor<a class="headerlink" href="#mosaic-descriptor" title="Link
353351
<dd><p>Data structure describing unstructured MPAS meshes.</p>
354352
<p>Enables visualization of fields defined at cell centers, vertices,
355353
and edges within <code class="docutils literal notranslate"><span class="pre">matplotlib</span></code> through the creation of
356-
<a class="reference external" href="https://matplotlib.org/stable/api/collections_api.html#matplotlib.collections.PolyCollection" title="(in Matplotlib v3.10.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">PolyCollection</span></code></a> objects. Separate patch
354+
<a class="reference external" href="https://matplotlib.org/stable/api/collections_api.html#matplotlib.collections.PolyCollection" title="(in Matplotlib v3.10.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">PolyCollection</span></code></a> objects. Separate patch
357355
arrays, which are subsequently passed to the
358-
<a class="reference external" href="https://matplotlib.org/stable/api/collections_api.html#matplotlib.collections.PolyCollection" title="(in Matplotlib v3.10.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">PolyCollection</span></code></a> class by the
356+
<a class="reference external" href="https://matplotlib.org/stable/api/collections_api.html#matplotlib.collections.PolyCollection" title="(in Matplotlib v3.10.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">PolyCollection</span></code></a> class by the
359357
<a class="reference internal" href="mosaic.polypcolor.html#mosaic.polypcolor" title="mosaic.polypcolor"><code class="xref py py-class docutils literal notranslate"><span class="pre">polypcolor</span></code></a> method,
360358
are lazily loaded for each variable location (i.e. cells, edges, and
361359
vertices) when attribute is first looked up. We use lazily loaded arrays

developers_guide/generated/mosaic.Descriptor.transform.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,8 @@
154154
<div class="bd-toc-item navbar-nav active">
155155
<p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
156156
<ul class="nav bd-sidenav">
157-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">file_format: mystnb kernelspec: name: python3</a></li>
158-
159-
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">file_format: mystnb kernelspec: name: python3</a></li>
160-
157+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/quick_start.html">Quick Start for Users</a></li>
158+
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/wrapping.html">Periodic Mesh Support</a></li>
161159
</ul>
162160
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Developers Guide:</span></p>
163161
<ul class="nav bd-sidenav">

0 commit comments

Comments
 (0)