From 9f66cc2e650aad63d45d8eef193c0e62eab5d2f8 Mon Sep 17 00:00:00 2001 From: Azure Pipelines Date: Thu, 30 May 2024 11:58:39 +0000 Subject: [PATCH] [skip ci] Update stable --- stable/_modules/mpas_tools/seaice/partition.html | 4 ++-- 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 | 4 ++-- .../generated/mpas_tools.mesh.cull.cull_dataset.html | 8 ++++---- .../mpas_tools.mesh.cull.map_culled_to_base.html | 4 ++-- ...s_tools.mesh.mask.compute_lon_lat_region_masks.html | 2 +- ...s_tools.mesh.mask.compute_mpas_flood_fill_mask.html | 6 +++--- ...mpas_tools.mesh.mask.compute_mpas_region_masks.html | 4 ++-- ...as_tools.mesh.mask.compute_mpas_transect_masks.html | 4 ++-- ...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 +++--- ..._tools.ocean.moc.make_moc_basins_and_transects.html | 2 +- ...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 | 6 +++--- 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 +- .../mpas_tools.viz.paraview_extractor.extract_vtk.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 | 8 ++++---- 31 files changed, 69 insertions(+), 69 deletions(-) diff --git a/stable/_modules/mpas_tools/seaice/partition.html b/stable/_modules/mpas_tools/seaice/partition.html index f06ebc74..9af0e266 100644 --- a/stable/_modules/mpas_tools/seaice/partition.html +++ b/stable/_modules/mpas_tools/seaice/partition.html @@ -502,8 +502,8 @@

Source code for mpas_tools.seaice.partition

     print("Regrid to desired mesh...")
     filenameOut = "icePresent_regrid.nc"
 
-    meshFilenameSrc = os.path.join(data_dir, 'seaice_QU60km_polar.nc')
-    filenameData = os.path.join(data_dir, 'icePresent_QU60km_polar.nc')
+    meshFilenameSrc = os.path.join(args.dataDir, 'seaice_QU60km_polar.nc')
+    filenameData = os.path.join(args.dataDir, 'icePresent_QU60km_polar.nc')
 
     regrid_to_other_mesh(
         meshFilenameSrc=meshFilenameSrc,
diff --git a/stable/generated/mpas_tools.io.write_netcdf.html b/stable/generated/mpas_tools.io.write_netcdf.html
index 5a331637..db4c60ae 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 dc5be562..61290877 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 b83c28eb..e898eafd 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 e9fbc13a..04c7b34c 100644 --- a/stable/generated/mpas_tools.mesh.conversion.mask.html +++ b/stable/generated/mpas_tools.mesh.conversion.mask.html @@ -164,8 +164,8 @@

        mpas_tools.mesh.conversion.mask
        Parameters:
          -
        • 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

        • +
        • 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 produced during mask creation and then deleted upon completion.

        • diff --git a/stable/generated/mpas_tools.mesh.cull.cull_dataset.html b/stable/generated/mpas_tools.mesh.cull.cull_dataset.html index 147f10f8..c5547801 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 55496d61..86e6b409 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_lon_lat_region_masks.html b/stable/generated/mpas_tools.mesh.mask.compute_lon_lat_region_masks.html index 76198a52..1d64bebb 100644 --- a/stable/generated/mpas_tools.mesh.mask.compute_lon_lat_region_masks.html +++ b/stable/generated/mpas_tools.mesh.mask.compute_lon_lat_region_masks.html @@ -166,7 +166,7 @@

            mpas_tools.mesh.mask.compute_lon_lat_region_masks
            • lon (numpy.ndarray) – A 1D array of longitudes in degrees between -180 and 180

            • lat (numpy.ndarray) – A 1D array of latitudes in degrees between -90 and 90

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

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

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

            • pool (multiprocessing.Pool, optional) – A pool for performing multiprocessing

            • chunkSize (int, optional) – The number of cells, vertices or edges that are processed in one 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 b0700e3b..03e24860 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

              • -
              • 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 +

              • 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 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 58677c9a..22943269 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,8 +164,8 @@

                mpas_tools.mesh.mask.compute_mpas_region_masks
                Parameters:
                  -
                • 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

                • +
                • 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 (e.g. dsMesh.latCell and dsMesh.lonCell for 'cell') are 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 59780b04..126293fa 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,8 +164,8 @@

                  mpas_tools.mesh.mask.compute_mpas_transect_masks
                  Parameters:
                    -
                  • 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

                  • +
                  • 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 the latitude and longitude associated with each of these locations 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 21159fba..ae7d57b9 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 fb00e55d..16619d74 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 f210d108..1c4efeb1 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 ba726ac2..08a71a8f 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 5e2587e5..06c37a75 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.moc.make_moc_basins_and_transects.html b/stable/generated/mpas_tools.ocean.moc.make_moc_basins_and_transects.html index 13b4b66f..98658467 100644 --- a/stable/generated/mpas_tools.ocean.moc.make_moc_basins_and_transects.html +++ b/stable/generated/mpas_tools.ocean.moc.make_moc_basins_and_transects.html @@ -182,7 +182,7 @@

                    mpas_tools.ocean.moc.make_moc_basins_and_transects
                    Parameters:
                      -
                    • gf (geometric_features.GeometricFeatures) – An object that knows how to download and read geometric features

                    • +
                    • gf (geometric_features.GeometricFeatures) – An object that knows how to download and read geometric features

                    • mesh_filename (str) – A file with MPAS mesh information

                    • mask_and_transect_filename (str) – A file to write the MOC region masks and southern-boundary transects to

                    • geojson_filename (str, optional) – A file to write MOC regions to

                    • 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 59c2d89e..f1bd2650 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 c7816948..90f902e9 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 0ef43560..374572ae 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 13f6cfe9..7d820bfd 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 702a4c1f..d42ab648 100644 --- a/stable/generated/mpas_tools.ocean.viz.plot_ocean_transects.html +++ b/stable/generated/mpas_tools.ocean.viz.plot_ocean_transects.html @@ -183,9 +183,9 @@

                      mpas_tools.ocean.viz.plot_ocean_transects
                      Parameters:
                        -
                      • 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

                      • +
                      • 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

                      • 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 a6afbd93..74af03db 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 53b2a85f..d96a41a0 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 05a730ec..8c3f0a6f 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 a6d56a94..1bbc3c72 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.paraview_extractor.extract_vtk.html b/stable/generated/mpas_tools.viz.paraview_extractor.extract_vtk.html index b4c9ef9e..76b1c145 100644 --- a/stable/generated/mpas_tools.viz.paraview_extractor.extract_vtk.html +++ b/stable/generated/mpas_tools.viz.paraview_extractor.extract_vtk.html @@ -233,7 +233,7 @@

                      mpas_tools.viz.paraview_extractor.extract_vtkbool, optional) – Whether to include mesh variables as well as time-series variables in the extraction

                      -
                    • fc_region_mask (geometric_features.FeatureCollection, optional) – A feature collection used to define a mask. The MPAS data is culled to +

                    • fc_region_mask (geometric_features.FeatureCollection, optional) – A feature collection used to define a mask. The MPAS data is culled to lie within the mask before conversion to VTK proceeds

                    • temp_dir (str, optional) – If fc_region_mask is supplied, a temporary directory where the culled mesh and time series files are stored

                    • 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 7c5d2713..63771349 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 4d90736d..31fbb20f 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: