From 3f2eccc222df8c28af6ae94d32c23a63c26a251f Mon Sep 17 00:00:00 2001 From: Azure Pipelines Date: Thu, 11 Apr 2024 00:11:48 +0000 Subject: [PATCH] [skip ci] Update stable --- stable/generated/mpas_tools.io.write_netcdf.html | 4 ++-- .../generated/mpas_tools.mesh.conversion.convert.html | 2 +- stable/generated/mpas_tools.mesh.conversion.cull.html | 8 ++++---- stable/generated/mpas_tools.mesh.conversion.mask.html | 2 +- .../generated/mpas_tools.mesh.cull.cull_dataset.html | 8 ++++---- .../mpas_tools.mesh.cull.map_culled_to_base.html | 4 ++-- ...s_tools.mesh.mask.compute_mpas_flood_fill_mask.html | 4 ++-- ...mpas_tools.mesh.mask.compute_mpas_region_masks.html | 2 +- ...as_tools.mesh.mask.compute_mpas_transect_masks.html | 2 +- ...astline_alteration.add_critical_land_blockages.html | 4 ++-- ...tline_alteration.add_land_locked_cells_to_mask.html | 4 ++-- ...coastline_alteration.widen_transect_edge_masks.html | 4 ++-- .../mpas_tools.ocean.depth.compute_depth.html | 2 +- .../generated/mpas_tools.ocean.depth.compute_zmid.html | 6 +++--- ...ean.transects.find_transect_levels_and_weights.html | 10 +++++----- ...ansects.interp_mpas_to_transect_triangle_nodes.html | 4 ++-- ...an.transects.interp_mpas_to_transect_triangles.html | 4 ++-- ...nterp_transect_grid_to_transect_triangle_nodes.html | 4 ++-- .../mpas_tools.ocean.viz.plot_ocean_transects.html | 4 ++-- stable/generated/mpas_tools.translate.center.html | 2 +- .../generated/mpas_tools.translate.center_on_mesh.html | 4 ++-- stable/generated/mpas_tools.translate.translate.html | 2 +- ..._tools.viz.mesh_to_triangles.mesh_to_triangles.html | 2 +- ...ansects.find_planar_transect_cells_and_weights.html | 8 ++++---- ....viz.transects.find_transect_cells_and_weights.html | 8 ++++---- .../mpas_tools.viz.transects.make_triangle_tree.html | 2 +- stable/mesh_conversion.html | 2 +- 27 files changed, 56 insertions(+), 56 deletions(-) diff --git a/stable/generated/mpas_tools.io.write_netcdf.html b/stable/generated/mpas_tools.io.write_netcdf.html index e2cdb981..bc0248ed 100644 --- a/stable/generated/mpas_tools.io.write_netcdf.html +++ b/stable/generated/mpas_tools.io.write_netcdf.html @@ -149,7 +149,7 @@

mpas_tools.io.write_netcdf
Parameters:
    -

  • ds (xarray.Dataset) – The dataset to save

    • +

  • ds (xarray.Dataset) – The dataset to save

  • fileName (str) – The path for the NetCDF file to write

  • fillValues (dict, optional) – A dictionary of fill values for different NetCDF types. Default is mpas_tools.io.default_fills, which can be modified but which @@ -158,7 +158,7 @@

    mpas_tools.io.write_netcdfmpas_tools.io.default_format, which can be modified but which defaults to 'NETCDF3_64BIT'

  • engine ({'netcdf4', 'scipy', 'h5netcdf'}, optional) – The library to use for NetCDF output. The default is the same as -in xarray.Dataset.to_netcdf() and depends on format. +in xarray.Dataset.to_netcdf() and depends on format. You can override the default by setting mpas_tools.io.default_engine

  • char_dim_name (str, optional) – The name of the dimension used for character strings, or None to let diff --git a/stable/generated/mpas_tools.mesh.conversion.convert.html b/stable/generated/mpas_tools.mesh.conversion.convert.html index 8608e9e1..7dcf8348 100644 --- a/stable/generated/mpas_tools.mesh.conversion.convert.html +++ b/stable/generated/mpas_tools.mesh.conversion.convert.html @@ -165,7 +165,7 @@

    mpas_tools.mesh.conversion.convert
    Parameters:
      -

    • dsIn (xarray.Dataset) – A data set to convert

      • +

    • dsIn (xarray.Dataset) – A data set to convert

    • graphInfoFileName (str, optional) – A file path (relative or absolute) where the graph file (typically graph.info should be written out. By default, graph.info is not saved.

      • diff --git a/stable/generated/mpas_tools.mesh.conversion.cull.html b/stable/generated/mpas_tools.mesh.conversion.cull.html index e6eb4de7..b9b87155 100644 --- a/stable/generated/mpas_tools.mesh.conversion.cull.html +++ b/stable/generated/mpas_tools.mesh.conversion.cull.html @@ -167,13 +167,13 @@

      mpas_tools.mesh.conversion.cull
      Parameters:
        -

      • dsIn (xarray.Dataset) – A data set to cull, possibly with a cullCell field set to one where +

      • dsIn (xarray.Dataset) – A data set to cull, possibly with a cullCell field set to one where cells should be removed

        • -

      • dsMask (xarray.Dataset or list, optional) – A data set (or data sets) with region masks that are 1 where cells +

      • dsMask (xarray.Dataset or list, optional) – A data set (or data sets) with region masks that are 1 where cells should be culled

        • -

      • dsInverse (xarray.Dataset or list, optional) – A data set (or data sets) with region masks that are 0 where cells +

      • dsInverse (xarray.Dataset or list, optional) – A data set (or data sets) with region masks that are 0 where cells should be culled

        • -

      • dsPreserve (xarray.Dataset or list, optional) – A data set (or data sets) with region masks that are 1 where cells +

      • dsPreserve (xarray.Dataset or list, optional) – A data set (or data sets) with region masks that are 1 where cells should not be culled

      • graphInfoFileName (str, optional) – A file path (relative or absolute) where the graph file (typically culled_graph.info should be written out. By default, diff --git a/stable/generated/mpas_tools.mesh.conversion.mask.html b/stable/generated/mpas_tools.mesh.conversion.mask.html index fabfa0c4..da476bed 100644 --- a/stable/generated/mpas_tools.mesh.conversion.mask.html +++ b/stable/generated/mpas_tools.mesh.conversion.mask.html @@ -164,7 +164,7 @@

        mpas_tools.mesh.conversion.mask
        Parameters:
          -

        • dsMesh (xarray.Dataset, optional) – An MPAS mesh on which the masks should be created

          • +

        • dsMesh (xarray.Dataset, optional) – An MPAS mesh on which the masks should be created

        • fcMask (geometric_features.FeatureCollection, optional) – A feature collection containing features to use to create the mask

        • logger (logging.Logger, optional) – A logger for the output if not stdout

        • dir (str, optional) – A directory in which a temporary directory will be added with files diff --git a/stable/generated/mpas_tools.mesh.cull.cull_dataset.html b/stable/generated/mpas_tools.mesh.cull.cull_dataset.html index a0fb5bb9..eeb21645 100644 --- a/stable/generated/mpas_tools.mesh.cull.cull_dataset.html +++ b/stable/generated/mpas_tools.mesh.cull.cull_dataset.html @@ -165,10 +165,10 @@

          mpas_tools.mesh.cull.cull_dataset
          Parameters:
            -

          • ds (xarray.Dataset) – An MPAS dataset to cull

            • -

          • ds_base_mesh (xarray.Dataset) – The horizontal MPAS mesh before culling

            • -

          • ds_culled_mesh (xarray.Dataset) – The culled horizonal MPAS mesh

            • -

          • ds_map_culled_to_base (xarray.Dataset, optional) – An existing map from the base to the culled mesh created with +

          • ds (xarray.Dataset) – An MPAS dataset to cull

            • +

          • ds_base_mesh (xarray.Dataset) – The horizontal MPAS mesh before culling

            • +

          • ds_culled_mesh (xarray.Dataset) – The culled horizonal MPAS mesh

            • +

          • ds_map_culled_to_base (xarray.Dataset, optional) – An existing map from the base to the culled mesh created with write_map_culled_to_base() or map_culled_to_base(). The dataset will be created (but not returned or saved to disk) if it is not passed as an argument.

            • diff --git a/stable/generated/mpas_tools.mesh.cull.map_culled_to_base.html b/stable/generated/mpas_tools.mesh.cull.map_culled_to_base.html index f4fcd853..f84f3e2e 100644 --- a/stable/generated/mpas_tools.mesh.cull.map_culled_to_base.html +++ b/stable/generated/mpas_tools.mesh.cull.map_culled_to_base.html @@ -165,8 +165,8 @@

            mpas_tools.mesh.cull.map_culled_to_base
            Parameters:
              -

            • ds_base (xarray.Dataset) – The horizontal MPAS mesh before culling

              • -

            • ds_culled (xarray.Dataset) – The culled horizonal MPAS mesh

              • +

            • ds_base (xarray.Dataset) – The horizontal MPAS mesh before culling

              • +

            • ds_culled (xarray.Dataset) – The culled horizonal MPAS mesh

            • workers (int, optional) – The number of threads to use to query base mesh elements. The default is all available threads (workers=-1)

            diff --git a/stable/generated/mpas_tools.mesh.mask.compute_mpas_flood_fill_mask.html b/stable/generated/mpas_tools.mesh.mask.compute_mpas_flood_fill_mask.html index 4f58888f..df62c9e1 100644 --- a/stable/generated/mpas_tools.mesh.mask.compute_mpas_flood_fill_mask.html +++ b/stable/generated/mpas_tools.mesh.mask.compute_mpas_flood_fill_mask.html @@ -165,9 +165,9 @@

            mpas_tools.mesh.mask.compute_mpas_flood_fill_mask
            Parameters:
              -

            • dsMesh (xarray.Dataset) – An MPAS mesh on which the masks should be created

              • +

            • dsMesh (xarray.Dataset) – An MPAS mesh on which the masks should be created

            • fcSeed (geometric_features.FeatureCollection) – A feature collection containing points at which to start the flood fill

              • -

            • daGrow (xarray.DataArray, optional) – A data array of size nCells with a mask that is 1 anywhere the +

            • daGrow (xarray.DataArray, optional) – A data array of size nCells with a mask that is 1 anywhere the flood fill is allowed to grow. The default is that the mask is all ones.

            • logger (logging.Logger, optional) – A logger for the output if not stdout

              • diff --git a/stable/generated/mpas_tools.mesh.mask.compute_mpas_region_masks.html b/stable/generated/mpas_tools.mesh.mask.compute_mpas_region_masks.html index b426e4f8..6232aa70 100644 --- a/stable/generated/mpas_tools.mesh.mask.compute_mpas_region_masks.html +++ b/stable/generated/mpas_tools.mesh.mask.compute_mpas_region_masks.html @@ -164,7 +164,7 @@

              mpas_tools.mesh.mask.compute_mpas_region_masks
              Parameters:
                -

              • dsMesh (xarray.Dataset) – An MPAS mesh on which the masks should be created

                • +

              • dsMesh (xarray.Dataset) – An MPAS mesh on which the masks should be created

              • fcMask (geometric_features.FeatureCollection) – A feature collection containing features to use to create the mask

              • maskTypes (tuple of {'cell', 'edge', 'vertex'}, optional) – Which type(s) of masks to make. Masks are created based on whether the latitude and longitude associated with each of these locations diff --git a/stable/generated/mpas_tools.mesh.mask.compute_mpas_transect_masks.html b/stable/generated/mpas_tools.mesh.mask.compute_mpas_transect_masks.html index abd0f3ca..51fe55b0 100644 --- a/stable/generated/mpas_tools.mesh.mask.compute_mpas_transect_masks.html +++ b/stable/generated/mpas_tools.mesh.mask.compute_mpas_transect_masks.html @@ -164,7 +164,7 @@

                mpas_tools.mesh.mask.compute_mpas_transect_masks
                Parameters:
                  -

                • dsMesh (xarray.Dataset) – An MPAS mesh on which the masks should be created

                  • +

                • dsMesh (xarray.Dataset) – An MPAS mesh on which the masks should be created

                • fcMask (geometric_features.FeatureCollection) – A feature collection containing features to use to create the mask

                • earthRadius (float) – The radius of the earth in meters

                • maskTypes (tuple of {'cell', 'edge', 'vertex'}, optional) – Which type(s) of masks to make. Masks are created based on whether diff --git a/stable/generated/mpas_tools.ocean.coastline_alteration.add_critical_land_blockages.html b/stable/generated/mpas_tools.ocean.coastline_alteration.add_critical_land_blockages.html index d13b2f3f..da5e896f 100644 --- a/stable/generated/mpas_tools.ocean.coastline_alteration.add_critical_land_blockages.html +++ b/stable/generated/mpas_tools.ocean.coastline_alteration.add_critical_land_blockages.html @@ -181,8 +181,8 @@

                  mpas_tools.ocean.coastline_alteration.add_critical_land_blockages
                  Parameters:
                    -

                  • dsMask (xarray.Dataset) – The mask to which critical blockages should be added

                    • -

                  • dsBlockages (xarray.Dataset) – The transect masks defining critical land regions that should block +

                  • dsMask (xarray.Dataset) – The mask to which critical blockages should be added

                    • +

                  • dsBlockages (xarray.Dataset) – The transect masks defining critical land regions that should block ocean flow (e.g. the Antarctic Peninsula)

                  diff --git a/stable/generated/mpas_tools.ocean.coastline_alteration.add_land_locked_cells_to_mask.html b/stable/generated/mpas_tools.ocean.coastline_alteration.add_land_locked_cells_to_mask.html index e641829f..62d42519 100644 --- a/stable/generated/mpas_tools.ocean.coastline_alteration.add_land_locked_cells_to_mask.html +++ b/stable/generated/mpas_tools.ocean.coastline_alteration.add_land_locked_cells_to_mask.html @@ -182,8 +182,8 @@

                  mpas_tools.ocean.coastline_alteration.add_land_locked_cells_to_mask
                  Parameters:
                    -

                  • dsMask (xarray.Dataset) – A land-mask data set

                    • -

                  • dsMesh (xarray.Dataset) – MPAS Mesh data set

                    • +

                  • dsMask (xarray.Dataset) – A land-mask data set

                    • +

                  • dsMesh (xarray.Dataset) – MPAS Mesh data set

                  • latitude_threshold (float, optional) – Minimum latitude, in degrees, for transect widening

                  • nSweeps (int, optional) – Maximum number of sweeps to search for land-locked cells

                  diff --git a/stable/generated/mpas_tools.ocean.coastline_alteration.widen_transect_edge_masks.html b/stable/generated/mpas_tools.ocean.coastline_alteration.widen_transect_edge_masks.html index d5d1e4ac..b37650c0 100644 --- a/stable/generated/mpas_tools.ocean.coastline_alteration.widen_transect_edge_masks.html +++ b/stable/generated/mpas_tools.ocean.coastline_alteration.widen_transect_edge_masks.html @@ -182,8 +182,8 @@

                  mpas_tools.ocean.coastline_alteration.widen_transect_edge_masks
                  Parameters:
                    -

                  • dsMask (xarray.Dataset) – The mask to which critical blockages should be added

                    • -

                  • dsMesh (xarray.Dataset) – The transect masks defining critical land regions that should block +

                  • dsMask (xarray.Dataset) – The mask to which critical blockages should be added

                    • +

                  • dsMesh (xarray.Dataset) – The transect masks defining critical land regions that should block ocean flow (e.g. the Antarctic Peninsula)

                  • latitude_threshold (float) – Minimum latitude, degrees, for transect widening

                  diff --git a/stable/generated/mpas_tools.ocean.depth.compute_depth.html b/stable/generated/mpas_tools.ocean.depth.compute_depth.html index e148a4d1..9caf0dec 100644 --- a/stable/generated/mpas_tools.ocean.depth.compute_depth.html +++ b/stable/generated/mpas_tools.ocean.depth.compute_depth.html @@ -180,7 +180,7 @@

                  mpas_tools.ocean.depth.compute_depth
                  Parameters:
                  -

                  refBottomDepth (xarray.DataArray) – the depth of the bottom of each vertical layer in the initial state +

                  refBottomDepth (xarray.DataArray) – the depth of the bottom of each vertical layer in the initial state (perfect z-level coordinate)

                  Returns:
                  diff --git a/stable/generated/mpas_tools.ocean.depth.compute_zmid.html b/stable/generated/mpas_tools.ocean.depth.compute_zmid.html index 86e82204..3a0d203d 100644 --- a/stable/generated/mpas_tools.ocean.depth.compute_zmid.html +++ b/stable/generated/mpas_tools.ocean.depth.compute_zmid.html @@ -182,9 +182,9 @@

                  mpas_tools.ocean.depth.compute_zmid
                  Parameters:
                    -

                  • bottomDepth (xarray.DataArray) – the depth of the ocean bottom (positive)

                    • -

                  • maxLevelCell (xarray.DataArray) – the 1-based vertical index of the bottom of the ocean

                    • -

                  • layerThickness (xarray.DataArray) – the thickness of MPAS-Ocean layers (possibly as a function of time)

                    • +

                  • bottomDepth (xarray.DataArray) – the depth of the ocean bottom (positive)

                    • +

                  • maxLevelCell (xarray.DataArray) – the 1-based vertical index of the bottom of the ocean

                    • +

                  • layerThickness (xarray.DataArray) – the thickness of MPAS-Ocean layers (possibly as a function of time)

                  • depth_dim (str, optional) – the name of the vertical dimension

                  diff --git a/stable/generated/mpas_tools.ocean.transects.find_transect_levels_and_weights.html b/stable/generated/mpas_tools.ocean.transects.find_transect_levels_and_weights.html index 8e3b7d99..53acc661 100644 --- a/stable/generated/mpas_tools.ocean.transects.find_transect_levels_and_weights.html +++ b/stable/generated/mpas_tools.ocean.transects.find_transect_levels_and_weights.html @@ -187,12 +187,12 @@

                  mpas_tools.ocean.transects.find_transect_levels_and_weights
                  Parameters:
                  diff --git a/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangle_nodes.html b/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangle_nodes.html index 305c7b58..3c69028e 100644 --- a/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangle_nodes.html +++ b/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangle_nodes.html @@ -183,9 +183,9 @@

                  mpas_tools.ocean.transects.interp_mpas_to_transect_triangle_nodes
                  Parameters:
                    -

                  • dsTransectTriangles (xarray.Dataset) – A dataset that defines triangles making up an MPAS-Ocean transect, the +

                  • dsTransectTriangles (xarray.Dataset) – A dataset that defines triangles making up an MPAS-Ocean transect, the results of calling find_transect_levels_and_weights()

                    • -

                  • da (xarray.DataArray) – An MPAS-Ocean 3D field with dimensions nCells` and nVertLevels +

                  • da (xarray.DataArray) – An MPAS-Ocean 3D field with dimensions nCells` and nVertLevels (possibly among others)

                  diff --git a/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangles.html b/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangles.html index e3bd85c9..fc4cd844 100644 --- a/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangles.html +++ b/stable/generated/mpas_tools.ocean.transects.interp_mpas_to_transect_triangles.html @@ -182,9 +182,9 @@

                  mpas_tools.ocean.transects.interp_mpas_to_transect_triangles
                  Parameters:
                    -

                  • dsTransectTriangles (xarray.Dataset) – A dataset that defines triangles making up an MPAS-Ocean transect, the +

                  • dsTransectTriangles (xarray.Dataset) – A dataset that defines triangles making up an MPAS-Ocean transect, the results of calling find_transect_levels_and_weights()

                    • -

                  • da (xarray.DataArray) – An MPAS-Ocean 3D field with dimensions nCells` and nVertLevels +

                  • da (xarray.DataArray) – An MPAS-Ocean 3D field with dimensions nCells` and nVertLevels (possibly among others)

                  diff --git a/stable/generated/mpas_tools.ocean.transects.interp_transect_grid_to_transect_triangle_nodes.html b/stable/generated/mpas_tools.ocean.transects.interp_transect_grid_to_transect_triangle_nodes.html index f89a7a76..762be231 100644 --- a/stable/generated/mpas_tools.ocean.transects.interp_transect_grid_to_transect_triangle_nodes.html +++ b/stable/generated/mpas_tools.ocean.transects.interp_transect_grid_to_transect_triangle_nodes.html @@ -182,9 +182,9 @@

                  mpas_tools.ocean.transects.interp_transect_grid_to_transect_triangle_nodes
                  Parameters:
                  Returns:
                  diff --git a/stable/generated/mpas_tools.ocean.viz.plot_ocean_transects.html b/stable/generated/mpas_tools.ocean.viz.plot_ocean_transects.html index 97ba8557..eddd745a 100644 --- a/stable/generated/mpas_tools.ocean.viz.plot_ocean_transects.html +++ b/stable/generated/mpas_tools.ocean.viz.plot_ocean_transects.html @@ -184,8 +184,8 @@

                  mpas_tools.ocean.viz.plot_ocean_transectsParameters:

                  • fc (geometric_features.FeatureCollection) – The transects to plot

                    • -

                  • ds (xarray.Dataset) – The MPAS-Ocean dataset to plot

                    • -

                  • ds_mesh (xarray.Dataset, optional) – The MPAS-Ocean mesh to use for plotting, the same as ds by default

                    • +

                  • ds (xarray.Dataset) – The MPAS-Ocean dataset to plot

                    • +

                  • ds_mesh (xarray.Dataset, optional) – The MPAS-Ocean mesh to use for plotting, the same as ds by default

                  • variable_list (list of str, optional) – The variables to plot

                  • cmap (str, optional) – The name of a colormap to use

                  • flip (book, optional) – Whether to flip the x axes of all transect plot

                    • diff --git a/stable/generated/mpas_tools.translate.center.html b/stable/generated/mpas_tools.translate.center.html index 10463e8f..0ef376e8 100644 --- a/stable/generated/mpas_tools.translate.center.html +++ b/stable/generated/mpas_tools.translate.center.html @@ -163,7 +163,7 @@

                    mpas_tools.translate.center
                    Parameters:
                    -

                    mesh (xarray.Dataset) – A planar mesh to translate

                    +

                    mesh (xarray.Dataset) – A planar mesh to translate

                  diff --git a/stable/generated/mpas_tools.translate.center_on_mesh.html b/stable/generated/mpas_tools.translate.center_on_mesh.html index 762c2a98..21a3b8b1 100644 --- a/stable/generated/mpas_tools.translate.center_on_mesh.html +++ b/stable/generated/mpas_tools.translate.center_on_mesh.html @@ -164,8 +164,8 @@

                  mpas_tools.translate.center_on_mesh
                  Parameters:
                    -

                  • mesh (xarray.Dataset) – A planar mesh to translate

                    • -

                  • otherMesh (xarray.Dataset) – Another planar mesh whose center will become the center of this mesh. +

                  • mesh (xarray.Dataset) – A planar mesh to translate

                    • +

                  • otherMesh (xarray.Dataset) – Another planar mesh whose center will become the center of this mesh. Uses xCell,yCell or, if those fields do not exist, will secondly try x1,y1 fields

                  diff --git a/stable/generated/mpas_tools.translate.translate.html b/stable/generated/mpas_tools.translate.translate.html index a9b64413..279c4759 100644 --- a/stable/generated/mpas_tools.translate.translate.html +++ b/stable/generated/mpas_tools.translate.translate.html @@ -164,7 +164,7 @@

                  mpas_tools.translate.translate
                  Parameters:
                    -

                  • mesh (xarray.Dataset) – A planar mesh to translate

                    • +

                  • mesh (xarray.Dataset) – A planar mesh to translate

                  • xOffset (float, optional) – user-specified shift in the x-direction

                  • yOffset (float, optional) – user-specified shift in the y-direction

                  diff --git a/stable/generated/mpas_tools.viz.mesh_to_triangles.mesh_to_triangles.html b/stable/generated/mpas_tools.viz.mesh_to_triangles.mesh_to_triangles.html index ed66b04d..a89b60fc 100644 --- a/stable/generated/mpas_tools.viz.mesh_to_triangles.mesh_to_triangles.html +++ b/stable/generated/mpas_tools.viz.mesh_to_triangles.mesh_to_triangles.html @@ -147,7 +147,7 @@

                  mpas_tools.viz.mesh_to_triangles.mesh_to_triangles
                  Parameters:
                    -

                  • dsMesh (xarray.Dataset) – An MPAS mesh

                    • +

                  • dsMesh (xarray.Dataset) – An MPAS mesh

                  • periodicCopy (bool, optional) – Whether to make a periodic copy of triangles that cross -180/180 degrees longitude. This is helpful when plotting triangles in a lon/lat space.

                  diff --git a/stable/generated/mpas_tools.viz.transects.find_planar_transect_cells_and_weights.html b/stable/generated/mpas_tools.viz.transects.find_planar_transect_cells_and_weights.html index 461d0d8b..ec782292 100644 --- a/stable/generated/mpas_tools.viz.transects.find_planar_transect_cells_and_weights.html +++ b/stable/generated/mpas_tools.viz.transects.find_planar_transect_cells_and_weights.html @@ -147,11 +147,11 @@

                  mpas_tools.viz.transects.find_planar_transect_cells_and_weights
                  Parameters:
                    -

                  • xTransect (xarray.DataArray) – The x points defining segments making up the transect

                    • -

                  • yTransect (xarray.DataArray) – The y points defining segments making up the transect

                    • -

                  • dsTris (xarray.Dataset) – A dataset that defines triangles, the results of calling +

                  • xTransect (xarray.DataArray) – The x points defining segments making up the transect

                    • +

                  • yTransect (xarray.DataArray) – The y points defining segments making up the transect

                    • +

                  • dsTris (xarray.Dataset) – A dataset that defines triangles, the results of calling :py:func:`mpas_tools.viz.mesh_to_triangles.mesh_to_triangles()

                    • -

                  • dsMesh (xarray.Dataset) – A data set with the full MPAS mesh.

                    • +

                  • dsMesh (xarray.Dataset) – A data set with the full MPAS mesh.

                  • tree (scipy.spatial.cKDTree) – A tree of edge centers from triangles making up an MPAS mesh, the return value from make_triangle_tree()

                  • subdivisionRes (float, optional) – Resolution in m to use to subdivide the transect when looking for diff --git a/stable/generated/mpas_tools.viz.transects.find_transect_cells_and_weights.html b/stable/generated/mpas_tools.viz.transects.find_transect_cells_and_weights.html index 0e854e08..38401236 100644 --- a/stable/generated/mpas_tools.viz.transects.find_transect_cells_and_weights.html +++ b/stable/generated/mpas_tools.viz.transects.find_transect_cells_and_weights.html @@ -147,11 +147,11 @@

                    mpas_tools.viz.transects.find_transect_cells_and_weights
                    Parameters:
                      -

                    • lonTransect (xarray.DataArray) – The longitude of segments making up the transect

                      • -

                    • latTransect (xarray.DataArray) – The latitude of segments making up the transect

                      • -

                    • dsTris (xarray.Dataset) – A dataset that defines triangles, the results of calling +

                    • lonTransect (xarray.DataArray) – The longitude of segments making up the transect

                      • +

                    • latTransect (xarray.DataArray) – The latitude of segments making up the transect

                      • +

                    • dsTris (xarray.Dataset) – A dataset that defines triangles, the results of calling mpas_tools.viz.mesh_to_triangles.mesh_to_triangles()

                      • -

                    • dsMesh (xarray.Dataset) – A data set with the full MPAS mesh.

                      • +

                    • dsMesh (xarray.Dataset) – A data set with the full MPAS mesh.

                    • tree (scipy.spatial.cKDTree) – A tree of edge centers from triangles making up an MPAS mesh, the return value from make_triangle_tree()

                    • degrees (bool, optional) – Whether lonTransect and latTransect are in degrees (as opposed diff --git a/stable/generated/mpas_tools.viz.transects.make_triangle_tree.html b/stable/generated/mpas_tools.viz.transects.make_triangle_tree.html index 2c5130d5..cbb278e9 100644 --- a/stable/generated/mpas_tools.viz.transects.make_triangle_tree.html +++ b/stable/generated/mpas_tools.viz.transects.make_triangle_tree.html @@ -146,7 +146,7 @@

                      mpas_tools.viz.transects.make_triangle_tree
                      Parameters:
                      -

                      dsTris (xarray.Dataset) – A dataset that defines triangles, the results of calling +

                      dsTris (xarray.Dataset) – A dataset that defines triangles, the results of calling mpas_tools.viz.mesh_to_triangles.mesh_to_triangles()

                      Returns:
                      diff --git a/stable/mesh_conversion.html b/stable/mesh_conversion.html index c3fe16e8..32e4f5df 100644 --- a/stable/mesh_conversion.html +++ b/stable/mesh_conversion.html @@ -320,7 +320,7 @@

                      Computing MPAS Region Masksmpas_tools.mesh.mask.compute_mpas_region_masks() or the compute_mpas_region_masks command-line tool can be used to create region masks on cells, edges and/or vertices given an MPAS -mesh xarray.Dataset dsMesh and a +mesh xarray.Dataset dsMesh and a geometric_features.FeatureCollection fcMask containing regions. The resulting masks, in the variable regionCellMasks, are 1 where the center of the polygon corresponding to the cell, edge or vertex (see the