Skip to content

Commit 0587f94

Browse files
Update documentation
1 parent 85bf551 commit 0587f94

19 files changed

Lines changed: 45 additions & 45 deletions

latest/developers_guide/landice/generated/compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ <h1>compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP<a cla
131131
<span class="sig-prename descclassname"><span class="pre">compass.landice.tests.mismipplus.setup_mesh.</span></span><span class="sig-name descname"><span class="pre">mark_cull_cells_for_MISMIP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ds_mesh</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/compass/landice/tests/mismipplus/setup_mesh.html#mark_cull_cells_for_MISMIP"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP" title="Link to this definition"></a></dt>
132132
<dd><dl class="field-list simple">
133133
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
134-
<dd class="field-odd"><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.9.1)"><em>xarray.Dataset</em></a>)</p>
134+
<dd class="field-odd"><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.9.2)"><em>xarray.Dataset</em></a>)</p>
135135
</dd>
136136
</dl>
137137
</dd></dl>

latest/developers_guide/ocean/generated/compass.ocean.haney.compute_haney_number.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@ <h1>compass.ocean.haney.compute_haney_number<a class="headerlink" href="#compass
133133
<dl class="field-list simple">
134134
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
135135
<dd class="field-odd"><ul class="simple">
136-
<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.9.1)"><em>xarray.Dataset</em></a>) – A dataset with the MPAS-Ocean mesh</p></li>
137-
<li><p><strong>layer_thickness</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – A data array with layer thicknesses</p></li>
138-
<li><p><strong>ssh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – A data array with sea surface height</p></li>
136+
<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.9.2)"><em>xarray.Dataset</em></a>) – A dataset with the MPAS-Ocean mesh</p></li>
137+
<li><p><strong>layer_thickness</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – A data array with layer thicknesses</p></li>
138+
<li><p><strong>ssh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – A data array with sea surface height</p></li>
139139
<li><p><strong>show_progress</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 to show a progress bar</p></li>
140140
</ul>
141141
</dd>

latest/developers_guide/ocean/generated/compass.ocean.iceshelf.compute_land_ice_draft_from_pressure.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ <h1>compass.ocean.iceshelf.compute_land_ice_draft_from_pressure<a class="headerl
134134
<dl class="field-list simple">
135135
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
136136
<dd class="field-odd"><ul class="simple">
137-
<li><p><strong>land_ice_pressure</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – The pressure from the overlying land ice on the ocean</p></li>
138-
<li><p><strong>modify_mask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – A mask that is 1 where <code class="docutils literal notranslate"><span class="pre">landIcePressure</span></code> can be deviate from 0</p></li>
137+
<li><p><strong>land_ice_pressure</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – The pressure from the overlying land ice on the ocean</p></li>
138+
<li><p><strong>modify_mask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – A mask that is 1 where <code class="docutils literal notranslate"><span class="pre">landIcePressure</span></code> can be deviate from 0</p></li>
139139
<li><p><strong>ref_density</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>, </em><em>optional</em>) – A reference density for seawater displaced by the ice shelf</p></li>
140140
</ul>
141141
</dd>

latest/developers_guide/ocean/generated/compass.ocean.iceshelf.compute_land_ice_pressure_from_draft.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ <h1>compass.ocean.iceshelf.compute_land_ice_pressure_from_draft<a class="headerl
133133
<dl class="field-list simple">
134134
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
135135
<dd class="field-odd"><ul class="simple">
136-
<li><p><strong>land_ice_draft</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – The ice draft (sea surface height)</p></li>
137-
<li><p><strong>modify_mask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – A mask that is 1 where <code class="docutils literal notranslate"><span class="pre">landIcePressure</span></code> can be deviate from 0</p></li>
136+
<li><p><strong>land_ice_draft</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – The ice draft (sea surface height)</p></li>
137+
<li><p><strong>modify_mask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – A mask that is 1 where <code class="docutils literal notranslate"><span class="pre">landIcePressure</span></code> can be deviate from 0</p></li>
138138
<li><p><strong>ref_density</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>, </em><em>optional</em>) – A reference density for seawater displaced by the ice shelf</p></li>
139139
</ul>
140140
</dd>

latest/developers_guide/ocean/generated/compass.ocean.iceshelf.compute_land_ice_pressure_from_thickness.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ <h1>compass.ocean.iceshelf.compute_land_ice_pressure_from_thickness<a class="hea
133133
<dl class="field-list simple">
134134
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
135135
<dd class="field-odd"><ul class="simple">
136-
<li><p><strong>land_ice_thickness</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – The ice thickness</p></li>
137-
<li><p><strong>modify_mask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.1)"><em>xarray.DataArray</em></a>) – A mask that is 1 where <code class="docutils literal notranslate"><span class="pre">landIcePressure</span></code> can be deviate from 0</p></li>
136+
<li><p><strong>land_ice_thickness</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – The ice thickness</p></li>
137+
<li><p><strong>modify_mask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.9.2)"><em>xarray.DataArray</em></a>) – A mask that is 1 where <code class="docutils literal notranslate"><span class="pre">landIcePressure</span></code> can be deviate from 0</p></li>
138138
<li><p><strong>land_ice_density</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>, </em><em>optional</em>) – A reference density for land ice</p></li>
139139
</ul>
140140
</dd>

latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.geom.interpolate_geom.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ <h1>compass.ocean.tests.isomip_plus.geom.interpolate_geom<a class="headerlink" h
134134
<dl class="field-list simple">
135135
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
136136
<dd class="field-odd"><ul class="simple">
137-
<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.9.1)"><em>xarray.Dataset</em></a>) – An MPAS-Ocean mesh</p></li>
138-
<li><p><strong>ds_geom</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.1)"><em>xarray.Dataset</em></a>) – Ice-sheet topography produced by
137+
<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.9.2)"><em>xarray.Dataset</em></a>) – An MPAS-Ocean mesh</p></li>
138+
<li><p><strong>ds_geom</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.2)"><em>xarray.Dataset</em></a>) – Ice-sheet topography produced by
139139
<a class="reference internal" href="compass.ocean.tests.isomip_plus.process_geom.ProcessGeom.html#compass.ocean.tests.isomip_plus.process_geom.ProcessGeom" title="compass.ocean.tests.isomip_plus.process_geom.ProcessGeom"><code class="xref py py-class docutils literal notranslate"><span class="pre">compass.ocean.tests.isomip_plus.process_geom.ProcessGeom</span></code></a></p></li>
140140
<li><p><strong>min_ocean_fraction</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The minimum ocean fraction after interpolation, below which the cell
141141
is masked as land (which is not distinguished from grounded ice)</p></li>

latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.geom.interpolate_ocean_mask.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ <h1>compass.ocean.tests.isomip_plus.geom.interpolate_ocean_mask<a class="headerl
136136
<dl class="field-list simple">
137137
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
138138
<dd class="field-odd"><ul class="simple">
139-
<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.9.1)"><em>xarray.Dataset</em></a>) – An MPAS-Ocean mesh</p></li>
140-
<li><p><strong>ds_geom</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.1)"><em>xarray.Dataset</em></a>) – Ice-sheet topography produced by
139+
<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.9.2)"><em>xarray.Dataset</em></a>) – An MPAS-Ocean mesh</p></li>
140+
<li><p><strong>ds_geom</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.2)"><em>xarray.Dataset</em></a>) – Ice-sheet topography produced by
141141
<a class="reference internal" href="compass.ocean.tests.isomip_plus.process_geom.ProcessGeom.html#compass.ocean.tests.isomip_plus.process_geom.ProcessGeom" title="compass.ocean.tests.isomip_plus.process_geom.ProcessGeom"><code class="xref py py-class docutils literal notranslate"><span class="pre">compass.ocean.tests.isomip_plus.process_geom.ProcessGeom</span></code></a></p></li>
142142
<li><p><strong>min_ocean_fraction</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The minimum ocean fraction after interpolation, below which the cell
143143
is masked as land (which is not distinguished from grounded ice)</p></li>

latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.viz.plot.MoviePlotter.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,8 @@ <h1>compass.ocean.tests.isomip_plus.viz.plot.MoviePlotter<a class="headerlink" h
166166
<li><p><strong>expt</strong> (<em>{'Ocean0'</em><em>, </em><em>'Ocean1'</em><em>, </em><em>'Ocean2'}</em>) – The name of the experiment</p></li>
167167
<li><p><strong>sectionY</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The location along the y axis of a transect in the x-z plane to
168168
plot</p></li>
169-
<li><p><strong>dsMesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.1)"><em>xarray.Dataset</em></a>) – The MPAS mesh</p></li>
170-
<li><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.9.1)"><em>xarray.Dataset</em></a>) – The time series output</p></li>
169+
<li><p><strong>dsMesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.2)"><em>xarray.Dataset</em></a>) – The MPAS mesh</p></li>
170+
<li><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.9.2)"><em>xarray.Dataset</em></a>) – The time series output</p></li>
171171
<li><p><strong>showProgress</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 show a progressbar</p></li>
172172
</ul>
173173
</dd>

latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.viz.plot.TimeSeriesPlotter.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ <h1>compass.ocean.tests.isomip_plus.viz.plot.TimeSeriesPlotter<a class="headerli
151151
<li><p><strong>inFolder</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>optional</em>) – The folder with simulation results</p></li>
152152
<li><p><strong>outFolder</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>optional</em>) – The folder where images will be written</p></li>
153153
<li><p><strong>expt</strong> (<em>{'Ocean0'</em><em>, </em><em>'Ocean1'</em><em>, </em><em>'Ocean2'}</em><em>, </em><em>optional</em>) – The name of the experiment</p></li>
154-
<li><p><strong>dsMesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.1)"><em>xarray.Dataset</em></a><em>, </em><em>optional</em>) – The MPAS mesh</p></li>
155-
<li><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.9.1)"><em>xarray.Dataset</em></a><em>, </em><em>optional</em>) – The time series output</p></li>
154+
<li><p><strong>dsMesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.9.2)"><em>xarray.Dataset</em></a><em>, </em><em>optional</em>) – The MPAS mesh</p></li>
155+
<li><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.9.2)"><em>xarray.Dataset</em></a><em>, </em><em>optional</em>) – The time series output</p></li>
156156
</ul>
157157
</dd>
158158
</dl>

latest/developers_guide/ocean/generated/compass.ocean.vertical.init_vertical_coord.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ <h1>compass.ocean.vertical.init_vertical_coord<a class="headerlink" href="#compa
166166
<dd class="field-odd"><ul class="simple">
167167
<li><p><strong>config</strong> (<a class="reference internal" href="../../generated/compass.config.CompassConfigParser.html#compass.config.CompassConfigParser" title="compass.config.CompassConfigParser"><em>compass.config.CompassConfigParser</em></a>) – Configuration options with parameters used to construct the vertical
168168
grid</p></li>
169-
<li><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.9.1)"><em>xarray.Dataset</em></a>) – A data set containing <code class="docutils literal notranslate"><span class="pre">bottomDepth</span></code> and <code class="docutils literal notranslate"><span class="pre">ssh</span></code> variables used to
169+
<li><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.9.2)"><em>xarray.Dataset</em></a>) – A data set containing <code class="docutils literal notranslate"><span class="pre">bottomDepth</span></code> and <code class="docutils literal notranslate"><span class="pre">ssh</span></code> variables used to
170170
construct the vertical coordinate</p></li>
171171
</ul>
172172
</dd>

0 commit comments

Comments
 (0)