[skip ci] Update stable

stable/_sources/versions.rst.txt

@@ -43,6 +43,7 @@ Documentation    On GitHub
 `v0.28.0`_        `0.28.0`_
 `v0.29.0`_        `0.29.0`_
 `v0.30.0`_        `0.30.0`_
+`v0.31.0`_        `0.31.0`_
 ================ ===============
 
 .. _`stable`: ../stable/index.html
@@ -119,3 +120,5 @@ Documentation    On GitHub
 .. _`0.29.0`: https://github.com/MPAS-Dev/MPAS-Tools/tree/0.29.0
 .. _`v0.30.0`: ../0.30.0/index.html
 .. _`0.30.0`: https://github.com/MPAS-Dev/MPAS-Tools/tree/0.30.0
+.. _`v0.31.0`: ../0.31.0/index.html
+.. _`0.31.0`: https://github.com/MPAS-Dev/MPAS-Tools/tree/0.31.0

stable/generated/mpas_tools.io.write_netcdf.html

@@ -149,7 +149,7 @@ <h1>mpas_tools.io.write_netcdf<a class="headerlink" href="#mpas-tools-io-write-n
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<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 v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – The dataset to save</p></li>
+<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 v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – The dataset to save</p></li>
 <li><p><strong>fileName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The path for the NetCDF file to write</p></li>
 <li><p><strong>fillValues</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>, </em><em>optional</em>) – A dictionary of fill values for different NetCDF types.  Default is
 <code class="docutils literal notranslate"><span class="pre">mpas_tools.io.default_fills</span></code>, which can be modified but which
@@ -158,7 +158,7 @@ <h1>mpas_tools.io.write_netcdf<a class="headerlink" href="#mpas-tools-io-write-n
 <code class="docutils literal notranslate"><span class="pre">mpas_tools.io.default_format</span></code>, which can be modified but which
 defaults to <code class="docutils literal notranslate"><span class="pre">'NETCDF3_64BIT'</span></code></p></li>
 <li><p><strong>engine</strong> (<em>{'netcdf4'</em><em>, </em><em>'scipy'</em><em>, </em><em>'h5netcdf'}</em><em>, </em><em>optional</em>) – The library to use for NetCDF output.  The default is the same as
-in <a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.to_netcdf.html#xarray.Dataset.to_netcdf" title="(in xarray v2024.1.2.dev0)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">xarray.Dataset.to_netcdf()</span></code></a> and depends on <code class="docutils literal notranslate"><span class="pre">format</span></code>.
+in <a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.to_netcdf.html#xarray.Dataset.to_netcdf" title="(in xarray v2024.2.1.dev0)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">xarray.Dataset.to_netcdf()</span></code></a> and depends on <code class="docutils literal notranslate"><span class="pre">format</span></code>.
 You can override the default by setting
 <code class="docutils literal notranslate"><span class="pre">mpas_tools.io.default_engine</span></code></p></li>
 <li><p><strong>char_dim_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – The name of the dimension used for character strings, or None to let

stable/generated/mpas_tools.mesh.conversion.convert.html

@@ -161,7 +161,7 @@ <h1>mpas_tools.mesh.conversion.convert<a class="headerlink" href="#mpas-tools-me
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>dsIn</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – A data set to convert</p></li>
+<li><p><strong>dsIn</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – A data set to convert</p></li>
 <li><p><strong>graphInfoFileName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – A file path (relative or absolute) where the graph file (typically
 <code class="docutils literal notranslate"><span class="pre">graph.info</span></code> should be written out.  By default, <code class="docutils literal notranslate"><span class="pre">graph.info</span></code> is
 not saved.</p></li>

stable/generated/mpas_tools.mesh.conversion.cull.html

@@ -163,13 +163,13 @@ <h1>mpas_tools.mesh.conversion.cull<a class="headerlink" href="#mpas-tools-mesh-
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>dsIn</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – A data set to cull, possibly with a <code class="docutils literal notranslate"><span class="pre">cullCell</span></code> field set to one where
+<li><p><strong>dsIn</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – A data set to cull, possibly with a <code class="docutils literal notranslate"><span class="pre">cullCell</span></code> field set to one where
 cells should be removed</p></li>
-<li><p><strong>dsMask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>, </em><em>optional</em>) – A data set (or data sets) with region masks that are 1 where cells
+<li><p><strong>dsMask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>, </em><em>optional</em>) – A data set (or data sets) with region masks that are 1 where cells
 should be culled</p></li>
-<li><p><strong>dsInverse</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>, </em><em>optional</em>) – A data set (or data sets) with region masks that are 0 where cells
+<li><p><strong>dsInverse</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>, </em><em>optional</em>) – A data set (or data sets) with region masks that are 0 where cells
 should be culled</p></li>
-<li><p><strong>dsPreserve</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>, </em><em>optional</em>) – A data set (or data sets) with region masks that are 1 where cells
+<li><p><strong>dsPreserve</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>, </em><em>optional</em>) – A data set (or data sets) with region masks that are 1 where cells
 should <em>not</em> be culled</p></li>
 <li><p><strong>graphInfoFileName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – A file path (relative or absolute) where the graph file (typically
 <code class="docutils literal notranslate"><span class="pre">culled_graph.info</span></code> should be written out.  By default,

stable/generated/mpas_tools.mesh.conversion.mask.html

@@ -160,7 +160,7 @@ <h1>mpas_tools.mesh.conversion.mask<a class="headerlink" href="#mpas-tools-mesh-
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<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 v2024.1.2.dev0)"><em>xarray.Dataset</em></a><em>, </em><em>optional</em>) – An MPAS mesh on which the masks should be created</p></li>
+<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 v2024.2.1.dev0)"><em>xarray.Dataset</em></a><em>, </em><em>optional</em>) – An MPAS mesh on which the masks should be created</p></li>
 <li><p><strong>fcMask</strong> (<a class="reference external" href="http://mpas-dev.github.io/geometric_features/stable/generated/geometric_features.FeatureCollection.html#geometric_features.FeatureCollection" title="(in geometric_features v1.3.0)"><em>geometric_features.FeatureCollection</em></a><em>, </em><em>optional</em>) – A feature collection containing features to use to create the mask</p></li>
 <li><p><strong>logger</strong> (<a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><em>logging.Logger</em></a><em>, </em><em>optional</em>) – A logger for the output if not stdout</p></li>
 <li><p><strong>dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – A directory in which a temporary directory will be added with files

stable/generated/mpas_tools.mesh.mask.compute_mpas_flood_fill_mask.html

@@ -161,7 +161,7 @@ <h1>mpas_tools.mesh.mask.compute_mpas_flood_fill_mask<a class="headerlink" href=
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<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 v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – An MPAS mesh on which the masks should be created</p></li>
+<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 v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – An MPAS mesh on which the masks should be created</p></li>
 <li><p><strong>fcSeed</strong> (<a class="reference external" href="http://mpas-dev.github.io/geometric_features/stable/generated/geometric_features.FeatureCollection.html#geometric_features.FeatureCollection" title="(in geometric_features v1.3.0)"><em>geometric_features.FeatureCollection</em></a>) – A feature collection containing points at which to start the flood fill</p></li>
 <li><p><strong>logger</strong> (<a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><em>logging.Logger</em></a><em>, </em><em>optional</em>) – A logger for the output if not stdout</p></li>
 <li><p><strong>workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – The number of threads used for finding nearest neighbors.  The default

stable/generated/mpas_tools.mesh.mask.compute_mpas_region_masks.html

@@ -160,7 +160,7 @@ <h1>mpas_tools.mesh.mask.compute_mpas_region_masks<a class="headerlink" href="#m
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<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 v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – An MPAS mesh on which the masks should be created</p></li>
+<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 v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – An MPAS mesh on which the masks should be created</p></li>
 <li><p><strong>fcMask</strong> (<a class="reference external" href="http://mpas-dev.github.io/geometric_features/stable/generated/geometric_features.FeatureCollection.html#geometric_features.FeatureCollection" title="(in geometric_features v1.3.0)"><em>geometric_features.FeatureCollection</em></a>) – A feature collection containing features to use to create the mask</p></li>
 <li><p><strong>maskTypes</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><em>tuple</em></a><em> of </em><em>{'cell'</em><em>, </em><em>'edge'</em><em>, </em><em>'vertex'}</em><em>, </em><em>optional</em>) – Which type(s) of masks to make.  Masks are created based on whether
 the latitude and longitude associated with each of these locations

stable/generated/mpas_tools.mesh.mask.compute_mpas_transect_masks.html

@@ -160,7 +160,7 @@ <h1>mpas_tools.mesh.mask.compute_mpas_transect_masks<a class="headerlink" href="
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<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 v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – An MPAS mesh on which the masks should be created</p></li>
+<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 v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – An MPAS mesh on which the masks should be created</p></li>
 <li><p><strong>fcMask</strong> (<a class="reference external" href="http://mpas-dev.github.io/geometric_features/stable/generated/geometric_features.FeatureCollection.html#geometric_features.FeatureCollection" title="(in geometric_features v1.3.0)"><em>geometric_features.FeatureCollection</em></a>) – A feature collection containing features to use to create the mask</p></li>
 <li><p><strong>earthRadius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – The radius of the earth in meters</p></li>
 <li><p><strong>maskTypes</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><em>tuple</em></a><em> of </em><em>{'cell'</em><em>, </em><em>'edge'</em><em>, </em><em>'vertex'}</em><em>, </em><em>optional</em>) – Which type(s) of masks to make.  Masks are created based on whether

stable/generated/mpas_tools.ocean.coastline_alteration.add_critical_land_blockages.html

@@ -181,8 +181,8 @@ <h1>mpas_tools.ocean.coastline_alteration.add_critical_land_blockages<a class="h
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>dsMask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – The mask to which critical blockages should be added</p></li>
-<li><p><strong>dsBlockages</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – The transect masks defining critical land regions that should block
+<li><p><strong>dsMask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – The mask to which critical blockages should be added</p></li>
+<li><p><strong>dsBlockages</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – The transect masks defining critical land regions that should block
 ocean flow (e.g. the Antarctic Peninsula)</p></li>
 </ul>
 </dd>

stable/generated/mpas_tools.ocean.coastline_alteration.add_land_locked_cells_to_mask.html

@@ -182,8 +182,8 @@ <h1>mpas_tools.ocean.coastline_alteration.add_land_locked_cells_to_mask<a class=
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>dsMask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – A land-mask data set</p></li>
-<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 v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – MPAS Mesh data set</p></li>
+<li><p><strong>dsMask</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – A land-mask data set</p></li>
+<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 v2024.2.1.dev0)"><em>xarray.Dataset</em></a>) – MPAS Mesh data set</p></li>
 <li><p><strong>latitude_threshold</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a><em>, </em><em>optional</em>) – Minimum latitude, in degrees, for transect widening</p></li>
 <li><p><strong>nSweeps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Maximum number of sweeps to search for land-locked cells</p></li>
 </ul>