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

class polaris.tasks.e3sm.init.topo.combine.CombineStep(component, config, low_res=False)[source]

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, config, low_res=False)[source]

Create a new step

Parameters:

Methods

__init__(component, config[, low_res])

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 that must be produced by this step and may be made available as an input to steps, perhaps in other tasks.

constrain_resources(available_resources)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

get_subdir(low_res)

Get the subdirectory for the step based on the datasets :param low_res: Whether to use the low resolution configuration options :type low_res: bool, optional

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.

Attributes

ANTARCTIC

DATASETS

GLOBAL