Skip to content

Commit 38501a3

Browse files
Update documentation
1 parent 598cd7f commit 38501a3

File tree

33 files changed

+52
-52
lines changed

33 files changed

+52
-52
lines changed
9.1 KB
Binary file not shown.
9.1 KB
Binary file not shown.
9.11 KB
Binary file not shown.
9.11 KB
Binary file not shown.
9.1 KB
Binary file not shown.

main/.doctrees/environment.pickle

9.1 KB
Binary file not shown.

main/developers_guide/e3sm/init/generated/polaris.tasks.e3sm.init.topo.remap.MaskTopoStep.define_masks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ <h1>polaris.tasks.e3sm.init.topo.remap.MaskTopoStep.define_masks<a class="header
141141
for Antarctic ice shelves, which are included in both masks.</p>
142142
<dl class="field-list simple">
143143
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
144-
<dd class="field-odd"><p><strong>ds</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.4.1.dev0)"><em>xarray.Dataset</em></a>) – The dataset containing the topography fields</p>
144+
<dd class="field-odd"><p><strong>ds</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.6.1)"><em>xarray.Dataset</em></a>) – The dataset containing the topography fields</p>
145145
</dd>
146146
<dt class="field-even">Returns<span class="colon">:</span></dt>
147147
<dd class="field-even"><p><ul class="simple">

main/developers_guide/e3sm/init/generated/polaris.tasks.e3sm.init.topo.remap.RemapTopoStep.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@ <h1>polaris.tasks.e3sm.init.topo.remap.RemapTopoStep<a class="headerlink" href="
144144
sphere grid</p></li>
145145
<li><p><strong>smoothing</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>optional</em>) – Whether smoothing will be applied as part of the remapping</p></li>
146146
<li><p><strong>unsmoothed_topo</strong> (<em>polaris.tasks.e3sm.init.topo.RemapTopoStep</em><em>, </em><em>optional</em>) – A step with unsmoothed topography</p></li>
147-
<li><p><strong>expand_distance</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.4.1.dev0)"><em>xarray.DataArray</em></a>) – The distance to expand the topography mask</p></li>
148-
<li><p><strong>expand_factor</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.4.1.dev0)"><em>xarray.DataArray</em></a>) – The factor to expand the topography mask</p></li>
147+
<li><p><strong>expand_distance</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.6.1)"><em>xarray.DataArray</em></a>) – The distance to expand the topography mask</p></li>
148+
<li><p><strong>expand_factor</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.6.1)"><em>xarray.DataArray</em></a>) – The factor to expand the topography mask</p></li>
149149
<li><p><strong>do_remapping</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Whether to remap the topography. If False, the step will symlink
150150
to the unsmoothed topography file.</p></li>
151151
</ul>

main/developers_guide/framework/remapping.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@
129129
meshes. The <a class="reference external" href="https://mpas-dev.github.io/pyremap/stable/">pyremap</a> provides
130130
capabilities for making mapping files (which contain the weights needed to
131131
interpolate between meshes) and using them to remap files or
132-
<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.4.1.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.Dataset</span></code></a> objects. Polaris provides a step for producing
132+
<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.6.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.Dataset</span></code></a> objects. Polaris provides a step for producing
133133
such a mapping file. Under the hood, <code class="docutils literal notranslate"><span class="pre">pyremap</span></code> uses the
134134
<a class="reference external" href="https://earthsystemmodeling.org/docs/release/latest/ESMF_refdoc/node3.html#SECTION03020000000000000000">ESMF_RegridWeightGen</a>
135135
or <a class="reference external" href="https://sigma.mcs.anl.gov/moab/offline-remapping-workflow-with-mbtempest/">mbtempest</a>

main/developers_guide/generated/polaris.mpas.area_for_field.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ <h1>polaris.mpas.area_for_field<a class="headerlink" href="#polaris-mpas-area-fo
149149
<dl class="field-list simple">
150150
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
151151
<dd class="field-odd"><ul class="simple">
152-
<li><p><strong>ds_mesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.4.1.dev0)"><em>xarray.Dataset</em></a>) – The MPAS mesh</p></li>
153-
<li><p><strong>field</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.4.1.dev0)"><em>xarray.DataArray</em></a>) – The field whose dimensions determine which area to return</p></li>
152+
<li><p><strong>ds_mesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.6.1)"><em>xarray.Dataset</em></a>) – The MPAS mesh</p></li>
153+
<li><p><strong>field</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.6.1)"><em>xarray.DataArray</em></a>) – The field whose dimensions determine which area to return</p></li>
154154
</ul>
155155
</dd>
156156
<dt class="field-even">Returns<span class="colon">:</span></dt>

0 commit comments

Comments
 (0)