Skip to content

Commit 749868b

Browse files
Update documentation
1 parent 10bc421 commit 749868b

File tree

33 files changed

+52
-52
lines changed

33 files changed

+52
-52
lines changed
-2.21 MB
Binary file not shown.
-2.21 MB
Binary file not shown.
-2.21 MB
Binary file not shown.
-2.21 MB
Binary file not shown.
-2.21 MB
Binary file not shown.

main/.doctrees/environment.pickle

-2.21 MB
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
@@ -143,7 +143,7 @@ <h1>polaris.tasks.e3sm.init.topo.remap.MaskTopoStep.define_masks<a class="header
143143
for Antarctic ice shelves, which are included in both masks.</p>
144144
<dl class="field-list simple">
145145
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
146-
<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.7.2)"><em>xarray.Dataset</em></a>) – The dataset containing the topography fields</p>
146+
<dd class="field-odd"><p><strong>ds</strong> (<em>xarray.Dataset</em>) – The dataset containing the topography fields</p>
147147
</dd>
148148
<dt class="field-even">Returns<span class="colon">:</span></dt>
149149
<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
@@ -146,8 +146,8 @@ <h1>polaris.tasks.e3sm.init.topo.remap.RemapTopoStep<a class="headerlink" href="
146146
sphere grid</p></li>
147147
<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>
148148
<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>
149-
<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.7.2)"><em>xarray.DataArray</em></a>) – The distance to expand the topography mask</p></li>
150-
<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.7.2)"><em>xarray.DataArray</em></a>) – The factor to expand the topography mask</p></li>
149+
<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><em>xarray.DataArray</em>) – The distance to expand the topography mask</p></li>
150+
<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><em>xarray.DataArray</em>) – The factor to expand the topography mask</p></li>
151151
<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
152152
to the unsmoothed topography file.</p></li>
153153
</ul>

main/developers_guide/framework/remapping.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@
131131
meshes. The <a class="reference external" href="https://mpas-dev.github.io/pyremap/stable/">pyremap</a> provides
132132
capabilities for making mapping files (which contain the weights needed to
133133
interpolate between meshes) and using them to remap files or
134-
<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.7.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.Dataset</span></code></a> objects. Polaris provides a step for producing
134+
<code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.Dataset</span></code> objects. Polaris provides a step for producing
135135
such a mapping file. Under the hood, <code class="docutils literal notranslate"><span class="pre">pyremap</span></code> uses the
136136
<a class="reference external" href="https://earthsystemmodeling.org/docs/release/latest/ESMF_refdoc/node3.html#SECTION03020000000000000000">ESMF_RegridWeightGen</a>
137137
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
@@ -151,8 +151,8 @@ <h1>polaris.mpas.area_for_field<a class="headerlink" href="#polaris-mpas-area-fo
151151
<dl class="field-list simple">
152152
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
153153
<dd class="field-odd"><ul class="simple">
154-
<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.7.2)"><em>xarray.Dataset</em></a>) – The MPAS mesh</p></li>
155-
<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.7.2)"><em>xarray.DataArray</em></a>) – The field whose dimensions determine which area to return</p></li>
154+
<li><p><strong>ds_mesh</strong> (<em>xarray.Dataset</em>) – The MPAS mesh</p></li>
155+
<li><p><strong>field</strong> (<em>xarray.DataArray</em>) – The field whose dimensions determine which area to return</p></li>
156156
</ul>
157157
</dd>
158158
<dt class="field-even">Returns<span class="colon">:</span></dt>

0 commit comments

Comments
 (0)