Skip to content

_legacy_restart

RESTART_NAMES = ('fv_core.res', 'fv_srf_wnd.res', 'fv_tracer.res') module-attribute

RESTART_OPTIONAL_NAMES = ('sfc_data', 'phy_data') module-attribute

COUPLER_RES_NAME = 'coupler.res' module-attribute

open_restart(dirname, communicator, label='', only_names=None, to_state=None, tracer_properties=None)

Load restart files output by the Fortran model into a state dictionary.

Parameters:

Name Type Description Default
dirname str

location of restart files, can be local or remote

required
communicator Communicator

object for communication over the cubed sphere or tile

required
label str

prepended string on the restart files to load

''
only_names optional

list of standard names to load

None
to_state optional

if given, assign loaded data into pre-allocated quantities in this state dictionary

None

Returns:

Name Type Description
state dict

model state dictionary

get_coupler_res_filename(dirname, label)

restart_files(dirname, tile_index, label)

restart_filenames(dirname, tile_index, label)

get_rank_suffix(rank, total_ranks)

map_keys(old_dict, old_keys_to_new)

prepend_label(filename, label=None)

load_partial_state_from_restart_file(file, restart_properties, only_names=None)