polaris.tasks.e3sm.init.topo.combine.CombineStep

class polaris.tasks.e3sm.init.topo.combine.CombineStep(component, subdir, target_grid, resolution_name)

A step for combining global and antarctic topography datasets

Variables:

• resolution (float) – degrees (float) or face subdivisions (int)

• resolution_name (str) – either x.xxxx_degrees or NExxx

• combined_filename (str) – name of the combined topography file

• dst_scrip_filename (str) – name of the destination SCRIP file

• exodus_filename (str) – name of the exodus file for the cubed sphere mesh

__init__(component, subdir, target_grid, resolution_name)

Create a new step

Parameters:

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

• subdir (str) – The subdirectory within the component’s work directory

• target_grid ({'cubed_sphere', 'lat_lon'}) – The type of target grid for the combined topography

• resolution_name (str) – The target resolution name for the combined topography

Methods

__init__(component, subdir, target_grid, ...)	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
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
get_name(target_grid, resolution_name)	Get the step name based on the current datasets and target grid.
get_subdir()	Get the base subdirectory for the step based on the datasets.
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
runtime_setup()	Update attributes of the step at runtime before calling the run() method.
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()	Set up the step in the work directory, including downloading any dependencies.
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

ANTARCTIC
DATASETS
GLOBAL
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