Polaris
User's guide
Quick Start for Users
Tasks
Config Files
Suites
Mesh component
E3SM Initial Condition Component
Ocean component
Sea ice component
Machines
Developer's guide
Quick Start for Developers
Overview
Command-line interface
Organization of Tasks
E3SM initial condition (e3sm/init) component
Mesh component
Ocean component
Sea ice component
Framework
Machines
Benchmarking a branch against a baseline
Troubleshooting
Documentation
Building the Documentation
Previewing the Documentation
How Conda and Spack Work Together in Polaris
Updating Deployment Dependencies
Updating Shared Spack Environments
API reference
Components
polaris framework
Command-line interface
Base Classes
analysis
attrs
component_graph
config
coriolis
io
job
logging
constants
mesh
Spherical Base Meshes
Coastlines and Critical Transects
Unified Meshes
polaris.mesh.spherical.unified.UNIFIED_MESH_NAMES
polaris.mesh.spherical.unified.LAT_LON_TARGET_GRID_RESOLUTIONS
polaris.mesh.spherical.unified.RIVER_CONFIG_FILENAME
polaris.mesh.spherical.unified.get_unified_mesh_config
polaris.mesh.spherical.unified.get_unified_mesh_family
polaris.mesh.spherical.unified.get_unified_background_cell_width
polaris.mesh.spherical.unified.get_unified_finest_cell_width
polaris.mesh.spherical.unified.UnifiedBaseMeshStep
polaris.mesh.spherical.unified.UnifiedBaseMeshStep.setup
polaris.mesh.spherical.unified.UnifiedBaseMeshStep.build_cell_width_lat_lon
polaris.mesh.spherical.unified.UnifiedBaseMeshStep.make_jigsaw_mesh
polaris.mesh.spherical.unified.families.UnifiedMeshFamily
polaris.mesh.spherical.unified.families.UnifiedMeshFamily.setup_sizing_field_step
polaris.mesh.spherical.unified.families.UnifiedMeshFamily.build_ocean_background
polaris.mesh.spherical.unified.families.default.DefaultUnifiedMeshFamily
polaris.mesh.spherical.unified.families.default.build_ocean_background_from_mode
polaris.mesh.spherical.unified.families.so_region.SORegionUnifiedMeshFamily
polaris.mesh.spherical.unified.effective_ocean.build_effective_ocean_mask
polaris.mesh.spherical.unified.effective_ocean.block_average
polaris.mesh.spherical.unified.effective_ocean.variable_box_average
polaris.mesh.spherical.unified.effective_ocean.widen_passages
polaris.mesh.spherical.unified.effective_ocean.flood_fill_from_seeds
polaris.mesh.spherical.unified.effective_ocean.hysteresis_grow
polaris.mesh.spherical.unified.river.distance.haversine_distance
polaris.mesh.spherical.unified.river.geojson.read_geojson
polaris.mesh.spherical.unified.river.geojson.write_geojson
model_step
build
mpas
parallel
namelist
provenance
remap
resolution
streams
validate
viz
yaml
Design Documents
Tutorials
Developer Tutorial: Adding a New Category of Tasks
Glossary
Glossary
Polaris
API reference
polaris.mesh.spherical.unified.families.UnifiedMeshFamily.build_ocean_background
View page source
polaris.mesh.spherical.unified.families.UnifiedMeshFamily.build_ocean_background
UnifiedMeshFamily.
build_ocean_background
(
ds_coastline
,
section
)
[source]