Skip to content

Commit

Permalink
[skip ci] Update stable
Browse files Browse the repository at this point in the history
  • Loading branch information
Azure Pipelines committed Sep 9, 2024
1 parent e1f31df commit 53d4fc9
Show file tree
Hide file tree
Showing 54 changed files with 117 additions and 280 deletions.
19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.cime.constants.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,4 @@

.. automodule:: mpas_tools.cime.constants




















19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.landice.visualization.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,11 @@
.. automodule:: mpas_tools.landice.visualization







.. rubric:: Functions

.. autosummary::

plot_grounding_lines
plot_map
plot_transect














19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.mesh.creation.build_mesh.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,10 @@
.. automodule:: mpas_tools.mesh.creation.build_mesh







.. rubric:: Functions

.. autosummary::

build_planar_mesh
build_spherical_mesh














19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.mesh.creation.mesh_definition_tools.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
.. automodule:: mpas_tools.mesh.creation.mesh_definition_tools







.. rubric:: Functions

.. autosummary::
Expand All @@ -17,16 +12,4 @@
EC_CellWidthVsLat
RRS_CellWidthVsLat
mergeCellWidthVsLat














19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.mesh.creation.signed_distance.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,11 @@
.. automodule:: mpas_tools.mesh.creation.signed_distance







.. rubric:: Functions

.. autosummary::

distance_from_geojson
mask_from_geojson
signed_distance_from_geojson














19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.ocean.build_mesh.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,10 @@
.. automodule:: mpas_tools.ocean.build_mesh







.. rubric:: Functions

.. autosummary::

build_planar_mesh
build_spherical_mesh














19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.ocean.coastal_tools.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
.. automodule:: mpas_tools.ocean.coastal_tools







.. rubric:: Functions

.. autosummary::
Expand All @@ -27,16 +22,4 @@
plot_region_box
save_matfile
smooth_coastline














19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.ocean.coastline_alteration.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,11 @@
.. automodule:: mpas_tools.ocean.coastline_alteration







.. rubric:: Functions

.. autosummary::

add_critical_land_blockages
add_land_locked_cells_to_mask
widen_transect_edge_masks














19 changes: 1 addition & 18 deletions stable/_sources/generated/mpas_tools.ocean.moc.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,10 @@
.. automodule:: mpas_tools.ocean.moc







.. rubric:: Functions

.. autosummary::

add_moc_southern_boundary_transects
make_moc_basins_and_transects














7 changes: 4 additions & 3 deletions stable/_static/searchtools.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ const Search = {

htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlinks", "script", "style"]) {
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
Expand Down Expand Up @@ -328,13 +328,14 @@ const Search = {
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score,
score + boost,
filenames[file],
]);
}
Expand Down
10 changes: 2 additions & 8 deletions stable/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -598,12 +598,7 @@ <h2>Ocean Tools<a class="headerlink" href="#ocean-tools" title="Link to this hea
<td><p>Builds features defining the ocean basins and southern transects used in computing the meridional overturning circulation (MOC)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/mpas_tools.ocean.moc.add_moc_southern_boundary_transects.html#mpas_tools.ocean.moc.add_moc_southern_boundary_transects" title="mpas_tools.ocean.moc.add_moc_southern_boundary_transects"><code class="xref py py-obj docutils literal notranslate"><span class="pre">moc.add_moc_southern_boundary_transects</span></code></a>(...)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">param dsMask<span class="colon">:</span></dt>
<dd class="field-odd"><p>Region masks defining MOC basins</p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/mpas_tools.ocean.build_mesh.html#module-mpas_tools.ocean.build_mesh" title="mpas_tools.ocean.build_mesh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">build_mesh</span></code></a></p></td>
<td><p></p></td>
Expand Down Expand Up @@ -771,8 +766,7 @@ <h2>Sea-ice Tools<a class="headerlink" href="#sea-ice-tools" title="Link to this
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/mpas_tools.seaice.regions.make_regions_file.html#mpas_tools.seaice.regions.make_regions_file" title="mpas_tools.seaice.regions.make_regions_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_regions_file</span></code></a>(filenameIcePresent, ...)</p></td>
<td><p><p>&quot;</p>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions stable/generated/mpas_tools.io.write_netcdf.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,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.6.1.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.7.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
Expand All @@ -163,7 +163,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.6.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>.
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.7.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
Expand Down
2 changes: 1 addition & 1 deletion stable/generated/mpas_tools.landice.visualization.plot_map.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h1>mpas_tools.landice.visualization.plot_map<a class="headerlink" href="#mpas-t
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to .nc file containing variables to plot. May contain
MALI mesh fields, or you can use the mesh_file argument.</p></li>
<li><p><strong>variable</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> or </em><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><em>numpy.ndarray</em></a>) – MALI variable to plot. If a string is specified, the variable with that
<li><p><strong>variable</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> or </em><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><em>numpy.ndarray</em></a>) – MALI variable to plot. If a string is specified, the variable with that
name will be read from the .nc file at data_path. If a numpy array is
given, that array will be plotted directly.</p></li>
<li><p><strong>ax</strong> (<em>matplotlib.axes._axes.Axes</em>) – Axes on which to plot variable</p></li>
Expand Down
2 changes: 1 addition & 1 deletion stable/generated/mpas_tools.mesh.conversion.convert.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,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.6.1.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.7.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>
Expand Down
8 changes: 4 additions & 4 deletions stable/generated/mpas_tools.mesh.conversion.cull.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,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.6.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
<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.7.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.6.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
<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.7.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.6.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
<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.7.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.6.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
<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.7.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,
Expand Down
4 changes: 2 additions & 2 deletions stable/generated/mpas_tools.mesh.conversion.mask.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ <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.6.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.4.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>dsMesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.7.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.5.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
produced during mask creation and then deleted upon completion.</p></li>
Expand Down
4 changes: 2 additions & 2 deletions stable/generated/mpas_tools.mesh.creation.signed_distance.distance_from_geojson.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ <h1>mpas_tools.mesh.creation.signed_distance.distance_from_geojson<a class="head
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>fc</strong> (<em>geometrics_features.FeatureCollection</em>) – The regions to be rasterized</p></li>
<li><p><strong>lon_grd</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><em>numpy.ndarray</em></a>) – A 1D array of longitude values</p></li>
<li><p><strong>lat_grd</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><em>numpy.ndarray</em></a>) – A 1D array of latitude values</p></li>
<li><p><strong>lon_grd</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><em>numpy.ndarray</em></a>) – A 1D array of longitude values</p></li>
<li><p><strong>lat_grd</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><em>numpy.ndarray</em></a>) – A 1D array of latitude values</p></li>
<li><p><strong>earth_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Earth radius in meters</p></li>
<li><p><strong>nn_search</strong> (<em>{'kdtree'}</em><em>, </em><em>optional</em>) – The method used to find the nearest point on the shape boundary</p></li>
<li><p><strong>max_length</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>) – The maximum distance (in degrees) between points on the boundary of the
Expand Down
Loading

0 comments on commit 53d4fc9

Please sign in to comment.