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 9fe38ca53..17f599ecf 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 @@
ds_mesh (xarray.Dataset)
+ds_mesh (xarray.Dataset)
ds_mesh (xarray.Dataset) – A dataset with the MPAS-Ocean mesh
layer_thickness (xarray.DataArray) – A data array with layer thicknesses
ssh (xarray.DataArray) – A data array with sea surface height
ds_mesh (xarray.Dataset) – A dataset with the MPAS-Ocean mesh
layer_thickness (xarray.DataArray) – A data array with layer thicknesses
ssh (xarray.DataArray) – A data array with sea surface height
show_progress (bool, optional) – Whether to show a progress bar
ssh (xarray.DataArray) – The sea surface height (the ice draft)
modify_mask (xarray.DataArray) – A mask that is 1 where landIcePressure
can be deviate from 0
ssh (xarray.DataArray) – The sea surface height (the ice draft)
modify_mask (xarray.DataArray) – A mask that is 1 where landIcePressure
can be deviate from 0
ref_density (float) – A reference density for seawater displaced by the ice shelf
ds_mesh (xarray.Dataset) – An MPAS-Ocean mesh
ds_geom (xarray.Dataset) – Ice-sheet topography produced by +
ds_mesh (xarray.Dataset) – An MPAS-Ocean mesh
ds_geom (xarray.Dataset) – Ice-sheet topography produced by
compass.ocean.tests.isomip_plus.process_geom.ProcessGeom
min_ocean_fraction (float) – The minimum ocean fraction after interpolation, below which the cell is masked as land (which is not distinguished from grounded ice)
ds_mesh (xarray.Dataset) – An MPAS-Ocean mesh
ds_geom (xarray.Dataset) – Ice-sheet topography produced by +
ds_mesh (xarray.Dataset) – An MPAS-Ocean mesh
ds_geom (xarray.Dataset) – Ice-sheet topography produced by
compass.ocean.tests.isomip_plus.process_geom.ProcessGeom
min_ocean_fraction (float) – The minimum ocean fraction after interpolation, below which the cell is masked as land (which is not distinguished from grounded ice)
expt ({'Ocean0', 'Ocean1', 'Ocean2'}) – The name of the experiment
sectionY (float) – The location along the y axis of a transect in the x-z plane to plot
dsMesh (xarray.Dataset) – The MPAS mesh
ds (xarray.Dataset) – The time series output
dsMesh (xarray.Dataset) – The MPAS mesh
ds (xarray.Dataset) – The time series output
showProgress (bool) – Whether to show a progressbar
outFolder (str, optional) – The folder where images will be written
expt ({'Ocean0', 'Ocean1', 'Ocean2'}, optional) – The name of the experiment
dsMesh (xarray.Dataset, optional) – The MPAS mesh
ds (xarray.Dataset, optional) – The time series output
dsMesh (xarray.Dataset, optional) – The MPAS mesh
ds (xarray.Dataset, optional) – The time series output
config (compass.config.CompassConfigParser) – Configuration options with parameters used to construct the vertical grid
ds (xarray.Dataset) – A data set containing bottomDepth
and ssh
variables used to
+
ds (xarray.Dataset) – A data set containing bottomDepth
and ssh
variables used to
construct the vertical coordinate
config (compass.config.CompassConfigParser) – Configuration options with parameters used to construct the vertical grid
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level
config (compass.config.CompassConfigParser) – Configuration options with parameters used to construct the vertical grid
ssh (xarray.DataArray) – The sea surface height
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level
ssh (xarray.DataArray) – The sea surface height
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level
refTopDepth (xarray.DataArray) – A 1D array of positive-down depths of the top of each z level
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
ssh (xarray.DataArray) – The sea surface height
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
refTopDepth (xarray.DataArray) – A 1D array of positive-down depths of the top of each z level
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
ssh (xarray.DataArray) – The sea surface height
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
refTopDepth (xarray.DataArray) – A 1D array of positive-down depths of the top of each z level
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
ssh (xarray.DataArray) – The sea surface height
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level
maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level
refTopDepth (xarray.DataArray) – A 1D array of positive-down depths of the top of each z level
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
ssh (xarray.DataArray) – The sea surface height
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level
maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level
layerThickness (xarray.DataArray) – The thickness of each layer (level)
ssh (xarray.DataArray) – The sea surface height
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level
maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level
layerThickness (xarray.DataArray) – The thickness of each layer (level)
ssh (xarray.DataArray) – The sea surface height
bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level
maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level
config (compass.config.CompassConfigParser) – Configuration options with parameters used to construct the vertical grid
ds (xarray.Dataset) – A data set containing bottomDepth
and ssh
variables used to
+
ds (xarray.Dataset) – A data set containing bottomDepth
and ssh
variables used to
construct the vertical coordinate
config (compass.config.CompassConfigParser) – Configuration options with parameters used to construct the vertical grid
ds (xarray.Dataset) – A data set containing bottomDepth
and ssh
variables used to
+
ds (xarray.Dataset) – A data set containing bottomDepth
and ssh
variables used to
construct the vertical coordinate
xarray.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 c8d5912bd..145a2b027 100644
--- a/latest/tutorials/dev_porting_legacy.html
+++ b/latest/tutorials/dev_porting_legacy.html
@@ -792,13 +792,13 @@
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