polaris.tasks.ocean.realistic_global.forward.Forward

class polaris.tasks.ocean.realistic_global.forward.Forward(component, package, mesh_name, mpaso_id, omega_id, ncells=None, name='forward', indir=None, subdir=None, update_eos=False, output_filename='output.nc', ntasks=None, min_tasks=None, options=None, replacements=None, validate_vars=None, check_properties=None)

A step for performing forward ocean component runs as part of the cosine bell test case

__init__(component, package, mesh_name, mpaso_id, omega_id, ncells=None, name='forward', indir=None, subdir=None, update_eos=False, output_filename='output.nc', ntasks=None, min_tasks=None, options=None, replacements=None, validate_vars=None, check_properties=None)

Create a new step

Parameters:

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

• name (str) – The name of the step

• subdir (str) – The subdirectory for the step

Methods

__init__(component, package, mesh_name, ...)	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_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_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()	This method should be overridden to check properties of step outputs
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.
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()	Make sure the restart directory exists before the model runs
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()	TEMP: symlink initial condition to name hard-coded in Omega
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.

Attributes

component
config
input_data