From 0a81e1d510dfd548c463306b39d3bceef66de038 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:56:52 +0000 Subject: [PATCH] Update documentation --- .../files_for_e3sm/diagnostic_masks.html | 2 +- ...hericalBaseStep.save_and_plot_cell_width.html | 6 +++--- .../compass.landice.mesh.build_mali_mesh.html | 2 +- ...ass.landice.mesh.get_dist_to_edge_and_gl.html | 8 ++++---- .../compass.landice.mesh.gridded_flood_fill.html | 2 +- .../compass.landice.mesh.mpas_flood_fill.html | 8 ++++---- ...compass.landice.mesh.preprocess_ais_data.html | 2 +- .../compass.landice.mesh.set_cell_width.html | 12 ++++++------ ...process_output.compute_convergence_rates.html | 6 +++--- ...ransport.process_output.plot_convergence.html | 16 ++++++++-------- ...rt.process_output.print_error_conv_table.html | 10 +++++----- ...ass.ocean.vertical.grid_1d.write_1d_grid.html | 2 +- 12 files changed, 38 insertions(+), 38 deletions(-) diff --git a/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/diagnostic_masks.html b/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/diagnostic_masks.html index d946f5210..0106ca21d 100644 --- a/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/diagnostic_masks.html +++ b/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/diagnostic_masks.html @@ -201,7 +201,7 @@
lon (numpy.ndarray) – longitude in degrees (length n and between -180 and 180)
lat (numpy.ndarray) – longitude in degrees (length m and between -90 and 90)
cell_width (numpy.ndarray) – m x n array of cell width in km
lon (numpy.ndarray) – longitude in degrees (length n and between -180 and 180)
lat (numpy.ndarray) – longitude in degrees (length m and between -90 and 90)
cell_width (numpy.ndarray) – m x n array of cell width in km
cell_width (numpy.ndarray) – Desired width of MPAS cells calculated by build_cell_width()
+
cell_width (numpy.ndarray) – Desired width of MPAS cells calculated by build_cell_width()
based on mesh density functions define in set_cell_width()
to pass to
mpas_tools.mesh.creation.build_mesh.build_planar_mesh()
.
thk (numpy.ndarray) – Ice thickness field from gridded dataset, +
thk (numpy.ndarray) – Ice thickness field from gridded dataset, usually after trimming to flood fill mask
topg (numpy.ndarray) – Bed topography field from gridded dataset
x (numpy.ndarray) – x coordinates from gridded dataset
y (numpy.ndarray) – y coordinates from gridded dataset
topg (numpy.ndarray) – Bed topography field from gridded dataset
x (numpy.ndarray) – x coordinates from gridded dataset
y (numpy.ndarray) – y coordinates from gridded dataset
section_name (str) – Section of the config file from which to read parameters. The
following options to be set in the given config section:
levels
, x_min
, x_max
, y_min
, y_max
,
diff --git a/latest/developers_guide/landice/generated/compass.landice.mesh.gridded_flood_fill.html b/latest/developers_guide/landice/generated/compass.landice.mesh.gridded_flood_fill.html
index fc797f8be..3026ba679 100644
--- a/latest/developers_guide/landice/generated/compass.landice.mesh.gridded_flood_fill.html
+++ b/latest/developers_guide/landice/generated/compass.landice.mesh.gridded_flood_fill.html
@@ -135,7 +135,7 @@
field (numpy.ndarray) – Array from gridded dataset to use for flood-fill. +
field (numpy.ndarray) – Array from gridded dataset to use for flood-fill. Usually ice thickness.
iStart (int) – x index from which to start flood fill for field. Defaults to the center x coordinate.
seed_mask (numpy.ndarray) – Integer array of locations from which to flood fill +
seed_mask (numpy.ndarray) – Integer array of locations from which to flood fill 0 = invalid, 1 = valid
grow_mask (numpy.ndarray) – Integer array of locations valid for growing into +
grow_mask (numpy.ndarray) – Integer array of locations valid for growing into 0 = invalid, 1 = valid
cellsOnCell (numpy.ndarray) – cellsOnCell array from the mpas mesh
nEdgesOnCell (numpy.ndarray) – nEdgesOnCell array from the mpas mesh
cellsOnCell (numpy.ndarray) – cellsOnCell array from the mpas mesh
nEdgesOnCell (numpy.ndarray) – nEdgesOnCell array from the mpas mesh
grow_iters (integer) – optional argument limiting the number of iterations over which to extend the mask
source_gridded_dataset (str) – name of NetCDF file containing original AIS gridded datasets
floodFillMask (numpy.ndarray) – 0/1 mask of flood filled ice region
floodFillMask (numpy.ndarray) – 0/1 mask of flood filled ice region
use_dist_to_grounding_line
, and use_bed
.
See the Land-Ice Framework section of the Users or Developers guide
for more information about these options and their uses.thk (numpy.ndarray) – Ice thickness field from gridded dataset, +
thk (numpy.ndarray) – Ice thickness field from gridded dataset, usually after trimming to flood fill mask
bed (numpy.ndarray) – Bed topography from gridded dataset
vx (numpy.ndarray, optional) – x-component of ice velocity from gridded dataset, +
bed (numpy.ndarray) – Bed topography from gridded dataset
vx (numpy.ndarray, optional) – x-component of ice velocity from gridded dataset,
usually after trimming to flood fill mask. Can be set to None
if use_speed == False
in config file.
vy (numpy.ndarray, optional) – y-component of ice velocity from gridded dataset, +
vy (numpy.ndarray, optional) – y-component of ice velocity from gridded dataset,
usually after trimming to flood fill mask. Can be set to None
if use_speed == False
in config file.
dist_to_edge (numpy.ndarray, optional) – Distance from each cell to ice edge, calculated in separate function. +
dist_to_edge (numpy.ndarray, optional) – Distance from each cell to ice edge, calculated in separate function.
Can be set to None
if use_dist_to_edge == False
in config file
and you do not want to set large cell_width
where cells will be
culled anyway, but this is not recommended.
dist_to_grounding_line (numpy.ndarray, optional) – Distance from each cell to grounding line, calculated in separate +
dist_to_grounding_line (numpy.ndarray, optional) – Distance from each cell to grounding line, calculated in separate
function. Can be set to None
if
use_dist_to_grounding_line == False
in config file.
flood_fill_iStart (int, optional) – x-index location to start flood-fill when using bed topography
dlambda (numpy.ndarray) – approximate mesh size
linf (numpy.ndarray) – linf relative error associated with each mesh size
l2 (numpy.ndarray) – l2 relative error associated with each mesh size
dlambda (numpy.ndarray) – approximate mesh size
linf (numpy.ndarray) – linf relative error associated with each mesh size
l2 (numpy.ndarray) – l2 relative error associated with each mesh size
ax (matplotlib.Axes) – A matplotlib Axes instance
tcname (str) – The name of the test case
dlambda (numpy.ndarray) – An array of mesh size values
resvals (numpy.ndarray) – An integer array of resolution values, e.g., [120, 240] +
dlambda (numpy.ndarray) – An array of mesh size values
resvals (numpy.ndarray) – An integer array of resolution values, e.g., [120, 240]
for QU120
and QU240
linf1 (numpy.ndarray) – the linf error for tracer1
l21 (numpy.ndarray) – the l2 error for tracer1
linf2 (numpy.ndarray) – the linf error for tracer2
l22 (numpy.ndarray) – the l2 error for tracer2
linf3 (numpy.ndarray) – the linf error for tracer3
l23 (numpy.ndarray) – the l2 error for tracer3
linf1 (numpy.ndarray) – the linf error for tracer1
l21 (numpy.ndarray) – the l2 error for tracer1
linf2 (numpy.ndarray) – the linf error for tracer2
l22 (numpy.ndarray) – the l2 error for tracer2
linf3 (numpy.ndarray) – the linf error for tracer3
l23 (numpy.ndarray) – the l2 error for tracer3
tcname (str) – Name of test case
resvals (list) – resolution values such as 240, for QU240
dlambda (numpy.ndarray) – approximate mesh size
l2 (numpy.ndarray) – l2 error, computed by compute_error_from_output_ncfile()
+
dlambda (numpy.ndarray) – approximate mesh size
l2 (numpy.ndarray) – l2 error, computed by compute_error_from_output_ncfile()
for tracer1
l2rates (numpy.ndarray) – appx. convergence rates for l2, computed by +
l2rates (numpy.ndarray) – appx. convergence rates for l2, computed by
compute_convergence_rates()
linf (numpy.ndarray) – linf error, computed by compute_error_from_output_ncfile()
+
linf (numpy.ndarray) – linf error, computed by compute_error_from_output_ncfile()
for tracer1
linfrates (numpy.ndarray) – appx. convergence rates for linf, computed +
linfrates (numpy.ndarray) – appx. convergence rates for linf, computed
by compute_convergence_rates()
interfaces (numpy.ndarray) – A 1D array of positive depths for layer interfaces in meters
interfaces (numpy.ndarray) – A 1D array of positive depths for layer interfaces in meters
out_filename (str) – MPAS file name for output of vertical grid