From ca25a2f39a8eb3103bcc3d780753898c19389dba Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 17 Jun 2024 09:15:32 +0000 Subject: [PATCH] Update documentation --- .../files_for_e3sm/remap_iceberg_climatology.html | 2 ++ ...ipplus.setup_mesh.mark_cull_cells_for_MISMIP.html | 2 +- .../compass.ocean.haney.compute_haney_number.html | 6 +++--- ...iceshelf.compute_land_ice_pressure_and_draft.html | 4 ++-- ...cean.tests.isomip_plus.geom.interpolate_geom.html | 4 ++-- ...ests.isomip_plus.geom.interpolate_ocean_mask.html | 4 ++-- ...cean.tests.isomip_plus.viz.plot.MoviePlotter.html | 4 ++-- ...tests.isomip_plus.viz.plot.TimeSeriesPlotter.html | 4 ++-- .../compass.ocean.vertical.init_vertical_coord.html | 2 +- ...an.vertical.partial_cells.alter_bottom_depth.html | 6 +++--- ...mpass.ocean.vertical.partial_cells.alter_ssh.html | 6 +++--- ...n.vertical.zlevel.compute_min_max_level_cell.html | 8 ++++---- ...tical.zlevel.compute_z_level_layer_thickness.html | 12 ++++++------ ...cal.zlevel.compute_z_level_resting_thickness.html | 10 +++++----- ....vertical.zlevel.init_z_level_vertical_coord.html | 2 +- ...an.vertical.zstar.init_z_star_vertical_coord.html | 2 +- latest/developers_guide/organization.html | 2 +- latest/tutorials/dev_porting_legacy.html | 4 ++-- 18 files changed, 43 insertions(+), 41 deletions(-) diff --git a/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/remap_iceberg_climatology.html b/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/remap_iceberg_climatology.html index 9fe38ca538..17f599ecf6 100644 --- a/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/remap_iceberg_climatology.html +++ b/latest/_modules/compass/ocean/tests/global_ocean/files_for_e3sm/remap_iceberg_climatology.html @@ -163,6 +163,8 @@

Source code for compass.ocean.tests.global_ocean.files_for_e3sm.remap_iceber Run this step of the test case """ super().run() + if not self.with_ice_shelf_cavities: + return logger = self.logger config = self.config ntasks = self.ntasks diff --git a/latest/developers_guide/landice/generated/compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP.html b/latest/developers_guide/landice/generated/compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP.html index 845dc91ea2..52feb1a9f8 100644 --- a/latest/developers_guide/landice/generated/compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP.html +++ b/latest/developers_guide/landice/generated/compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP.html @@ -134,7 +134,7 @@

compass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIPcompass.landice.tests.mismipplus.setup_mesh.mark_cull_cells_for_MISMIP(ds_mesh)[source]
Parameters:
-

ds_mesh (xarray.Dataset)

+

ds_mesh (xarray.Dataset)

diff --git a/latest/developers_guide/ocean/generated/compass.ocean.haney.compute_haney_number.html b/latest/developers_guide/ocean/generated/compass.ocean.haney.compute_haney_number.html index 0cc70b59c1..cacc3f4f49 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.haney.compute_haney_number.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.haney.compute_haney_number.html @@ -136,9 +136,9 @@

compass.ocean.haney.compute_haney_number
Parameters:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.iceshelf.compute_land_ice_pressure_and_draft.html b/latest/developers_guide/ocean/generated/compass.ocean.iceshelf.compute_land_ice_pressure_and_draft.html index c965bc3abc..3bd6811a25 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.iceshelf.compute_land_ice_pressure_and_draft.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.iceshelf.compute_land_ice_pressure_and_draft.html @@ -136,8 +136,8 @@

compass.ocean.iceshelf.compute_land_ice_pressure_and_draft
Parameters:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.geom.interpolate_geom.html b/latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.geom.interpolate_geom.html index 461bee856a..1790adaa40 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.geom.interpolate_geom.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.tests.isomip_plus.geom.interpolate_geom.html @@ -137,8 +137,8 @@

compass.ocean.tests.isomip_plus.geom.interpolate_geom
Parameters:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.init_vertical_coord.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.init_vertical_coord.html index 652d38668b..2c65fc1e02 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.init_vertical_coord.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.init_vertical_coord.html @@ -169,7 +169,7 @@

compass.ocean.vertical.init_vertical_coord diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_bottom_depth.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_bottom_depth.html index 4ee7b30a94..9a0741bbec 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_bottom_depth.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_bottom_depth.html @@ -139,9 +139,9 @@

compass.ocean.vertical.partial_cells.alter_bottom_depth
Returns:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_ssh.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_ssh.html index c568e536db..19dbf410a3 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_ssh.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.partial_cells.alter_ssh.html @@ -139,9 +139,9 @@

compass.ocean.vertical.partial_cells.alter_ssh
Returns:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_min_max_level_cell.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_min_max_level_cell.html index 864c91199c..94e9676dc8 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_min_max_level_cell.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_min_max_level_cell.html @@ -137,10 +137,10 @@

compass.ocean.vertical.zlevel.compute_min_max_level_cell
Parameters:
Returns:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_layer_thickness.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_layer_thickness.html index 3eeee21225..baafdf92d0 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_layer_thickness.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_layer_thickness.html @@ -136,12 +136,12 @@

compass.ocean.vertical.zlevel.compute_z_level_layer_thickness
Parameters:
Returns:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_resting_thickness.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_resting_thickness.html index ea92c1ae7e..33477f7d43 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_resting_thickness.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.compute_z_level_resting_thickness.html @@ -137,11 +137,11 @@

compass.ocean.vertical.zlevel.compute_z_level_resting_thickness
Parameters:
Returns:
diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.init_z_level_vertical_coord.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.init_z_level_vertical_coord.html index 01e818e13d..cb83f7f3aa 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.init_z_level_vertical_coord.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zlevel.init_z_level_vertical_coord.html @@ -169,7 +169,7 @@

compass.ocean.vertical.zlevel.init_z_level_vertical_coord diff --git a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zstar.init_z_star_vertical_coord.html b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zstar.init_z_star_vertical_coord.html index 8fed9aa72a..7e04fe8df6 100644 --- a/latest/developers_guide/ocean/generated/compass.ocean.vertical.zstar.init_z_star_vertical_coord.html +++ b/latest/developers_guide/ocean/generated/compass.ocean.vertical.zstar.init_z_star_vertical_coord.html @@ -169,7 +169,7 @@

compass.ocean.vertical.zstar.init_z_star_vertical_coord diff --git a/latest/developers_guide/organization.html b/latest/developers_guide/organization.html index 76d8ebfc37..a5578ef3fe 100644 --- a/latest/developers_guide/organization.html +++ b/latest/developers_guide/organization.html @@ -1317,7 +1317,7 @@

Directory structurexarray.Dataset, which is then written out to +condition to an xarray.Dataset, which is then written out to the file ocean.nc.

In the example step we’ve been using, compass.ocean.tests.baroclinic_channel.forward.Forward.run() looks diff --git a/latest/tutorials/dev_porting_legacy.html b/latest/tutorials/dev_porting_legacy.html index c8d5912bd0..145a2b0277 100644 --- a/latest/tutorials/dev_porting_legacy.html +++ b/latest/tutorials/dev_porting_legacy.html @@ -792,13 +792,13 @@

Defining the run methodplanar_hex, but compass will typically use the mpas_tools.planar_hex.make_planar_hex_mesh() function instead to avoid the complexity of subprocess calls and unnecessary file I/O. The -result is an xarray.Dataset containing the mesh.

+result is an xarray.Dataset containing the mesh.

Second, we make sure any land cells are culled by calling the cell culler. In legacy COMPASS, this is done with the command-line tool MpasCellCuller.x but in compass, the same can be achieved with mpas_tools.mesh.conversion.cull() (which is a wrapper around a subprocess` call to MpasCellCuller.x). cull() has -xarray.Dataset objects as its input an return value, and also +xarray.Dataset objects as its input an return value, and also takes a “logger” where it can write output (sometimes a log file and sometimes directly to the terminal via stdout). You should always pass self.logger so compass can figure out whether a file or stdout is the right place for