polaris.tasks.ocean.realistic_global.analysis_output.AnalysisOutputForward

class polaris.tasks.ocean.realistic_global.analysis_output.AnalysisOutputForward(component, init_condition: InitialCondition, subdir: str)[source]

A one-year Omega run that writes what the ocean analysis reads

The run is an ordinary realistic_global forward step, with monthly_output.yaml layered over the forward step’s yaml. That file replaces the History stream with monthly snapshots, turns on the MonthlyAverages and MOC analysis groups and writes restarts monthly, which Omega requires of a run with a monthly reduction. Every monthly file is declared as an output, so that a run whose analysis groups did not write is reported as a missing output rather than found later by the analysis, and every one is compared with a baseline when there is one (see MONTHLY_FILE_VALIDATION). The number of MOC latitude bins is the moc_num_bins option in the mesh’s [analysis_output] config section. The step supports only Omega, since the ocean analysis reads only Omega output.

__init__(component, init_condition: InitialCondition, subdir: str)[source]

Create the step

Parameters:

Methods

__init__(component, init_condition, subdir)

Create the step

add_cf_check([filename])

Check an output file for CF compliance after the step runs.

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_forcing_input_file(**kwargs)

Add the surface-forcing input file using a placeholder that is resolved to the configured filename at process_inputs_and_outputs() time.

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_cf()

Check every file Omega wrote for CF compliance: the first file of each write stream in the step's omega.yml, since the files of a stream share their metadata.

check_properties()

Check conservation properties of the output files of this step

compute_cell_count()

Compute the number of cells used to size 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 the monthly output over the forward step's own model config

get_forcing_filename()

Get the configured local filename for the surface forcing file.

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.

run()

Run the step.

runtime_setup()

Update IO task model config options, make graph file, and partition graph file (if any of these are requested)

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()

Raise unless the model is Omega, then set up the step

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