polaris.tasks.ocean.realistic_global.restart.restart_step.RestartStep

class polaris.tasks.ocean.realistic_global.restart.restart_step.RestartStep(component, name, subdir, mesh_name, mpaso_id, omega_id, ncells, replacements, previous_step=None, options=None)

One segment of the realistic global restart chain.

The chain is two segments that between them cover the same period as the task’s full_run. Both segments read and write restarts through a restarts directory shared by the whole task, following the restart chain in realistic_global/dynamic_adjustment, and the continuing segment appends its history to the frames the first segment already wrote.

Variables:

previous_step (polaris.Step or None) – The segment this one continues from, or None for the first segment of the chain.

__init__(component, name, subdir, mesh_name, mpaso_id, omega_id, ncells, replacements, previous_step=None, options=None)

Create the step

Parameters:

• component (polaris.tasks.ocean.Ocean) – The ocean component that this step belongs to

• name (str) – The name of the step

• subdir (str) – The subdirectory for the step

• mesh_name (str) – The name of the mesh (e.g. QU.240km)

• mpaso_id (int) – The ID of the MPAS-Ocean initial condition in the Polaris input database

• omega_id (int) – The ID of the Omega initial condition in the Polaris input database

• ncells (int) – The approximate number of cells in the mesh, used to constrain resources

• replacements (dict) – Template replacements for the forward yaml files

• previous_step (polaris.Step, optional) – The segment this one continues from. When given, this step reads that segment’s restart and appends to its history file.

• options (dict, optional) – Model config options for this step, keyed by the model they are for, as for Forward

Methods

__init__(component, name, subdir, mesh_name, ...)	Create the 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_horiz_mesh_input_file(**kwargs)	Add the horizontal-mesh input file using a placeholder that is resolved to the configured filename at process_inputs_and_outputs() time.
add_init_input_file(**kwargs)	Add the initial-condition input file using a placeholder that is resolved to the configured filename at process_inputs_and_outputs() time.
add_input_file([filename, target, database, ...])	Add an input file to the step (but not necessarily to the MPAS model).
add_model_config_options(options[, config_model])	Add the replacement model config options to be parsed when generating a namelist or yaml file if and when the step gets set up.
add_namelist_file(package, namelist)	Add a file with updates to namelist options to the step to be parsed when generating a complete namelist file if and when the step gets set up.
add_output_file(filename[, validate_vars, ...])	Add an output file, optionally resolving validate_class to a pre-defined list of variables from the Ocean component.
add_property_check(filename, check_properties)	Add a single conservation comparison for an output file
add_streams_file(package, streams[, ...])	Add a streams file to the step to be parsed when generating a complete streams file if and when the step gets set up.
add_vert_coord_input_file([filename])	Add the vertical-coordinate input file.
add_yaml_file(package, yaml[, ...])	Add a file with updates to yaml config options to the step to be parsed when generating a complete yaml file if and when the step gets set up.
check_properties()	Check conservation properties of the output files of this step
compute_cell_count()	Compute the approximate number of cells in the mesh, used to constrain resources
constrain_resources(available_cores)	Update the number of MPI tasks to use based on the estimated mesh size
dynamic_model_config(at_setup)	Add model config options, namelist, streams and yaml files using config options or template replacements that need to be set both during step setup and at runtime
get_horiz_mesh_filename()	Get the configured local filename for the horizontal mesh file.
get_init_filename()	Get the configured local filename for the initial-condition file.
get_vert_coord_filename()	Get the configured local filename for the vertical coordinate file.
map_yaml_configs(configs, config_model)	A mapping between model sections and config options from MPAS-Ocean to Omega
map_yaml_options(options, config_model)	A mapping between model config options from MPAS-Ocean to Omega
map_yaml_streams(streams, config_model)	A mapping between model streams from different models.
map_yaml_to_namelist(options)	A mapping from yaml model config options to namelist options.
open_model_dataset(filename[, config, ...])	Open the given dataset, mapping variable and dimension names from Omega to MPAS-Ocean names if appropriate
partition([graph_file])	Partition the domain for the requested number of tasks
process_inputs_and_outputs()	Process the model and any configured model-input placeholders.
restart_read_target()	The path, relative to the step's work directory, that this segment reads a restart from.
restart_write_dir()	The absolute path of the directory this segment writes its restart into
restart_write_target()	The path, relative to the step's work directory, that this segment writes its restart into.
run()	Run the step.
runtime_setup()	Make the shared restart directory, and seed the history file with the previous segment's frames when this segment continues from one
set_model_resources([ntasks, min_tasks, ...])	Update the resources for the step.
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()	Add this task's overrides on top of the shared realistic_global forward yaml, which Forward.setup() adds first
update_io_tasks_config([config_model])	Modify model config options so the number of IO tasks and the stride between them are consistent with how MPI tasks are distributed across nodes (one IO task per node).
update_namelist_eos()	Modify the namelist to make it consistent with eos config options
update_namelist_pio([config_model])	Deprecated alias for update_io_tasks_config().
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
component
config
input_data
logger