polaris.mesh.spherical.unified.UnifiedBaseMeshStep

class polaris.mesh.spherical.unified.UnifiedBaseMeshStep(component, sizing_field_step=None, river_clip_step=None, name='base_mesh', subdir=None, mesh_name='mesh')

A unified spherical mesh step with direct retained-river geometry input.

__init__(component, sizing_field_step=None, river_clip_step=None, name='base_mesh', subdir=None, mesh_name='mesh')

Create a new step

Parameters:

• component (polaris.Component) – The component the step belongs to

• name (str, optional) – the name of the step

• subdir ({str, None}, optional) – the subdirectory for the step

• cell_width (float, optional) – The approximate cell width in km of the mesh if constant resolution

• mesh_name (str, optional) – The name of the mesh

Methods

__init__(component[, sizing_field_step, ...])	Create a new step
add_dependency(step[, name])	Add step as a dependency of this step (i.e. this step can't run until the dependency has finished).
add_input_file([filename, target, database, ...])	Add an input file to the step (but not necessarily to the MPAS model).
add_output_file(filename[, validate_vars, ...])	Add the output file to the step
add_property_check(filename, check_properties)	Add a single conservation comparison for an output file
build_cell_width_lat_lon()	Read the cell width, lon, and lat directly from sizing_field.nc.
check_properties()	Check conservation properties of the output files of this step.
constrain_resources(available_resources)	Constrain cpus_per_task and ntasks based on the number of cores available to this step
make_jigsaw_mesh(lon, lat, cell_width)	Build the JIGSAW mesh with river polylines added to the geometry.
process_inputs_and_outputs()	Process the inputs to and outputs from a step added with polaris.Step.add_input_file() and polaris.Step.add_output_file().
run()	Run this step of the task
runtime_setup()	Make the JIGSAW file names absolute
save_and_plot_cell_width(lon, lat, cell_width)	Save the cell width field on a lon/lat grid to self.cell_width_filename and plot
set_resources([cpus_per_task, ...])	Update the resources for the subtask.
set_shared_config(config[, link])	Replace the step's config parser with the shared config parser
setup()	Link retained-river products in addition to the sizing field.
validate_baselines()	Compare variables between output files in this step and in the same step from a baseline run if one was provided.
work_path(*filenames)	Get the absolute path to a file or directory in the step's work directory

Attributes

cores	the number of cores this step needs, in total
gpus	the number of GPUs this step needs, in total
may_span_nodes	whether this step's cores and GPUs may come from several nodes
min_cores	the number of cores this step needs in order to run at all
min_gpus	the number of GPUs this step requires, in total