matflow.RunDirAppFiles

class matflow.RunDirAppFiles

Bases: RunDirAppFiles

A class to encapsulate the naming/recognition of app-created files within run directories.

Methods

get_commands_file_name	Get the name of the file containing commands.
get_run_file_prefix	Get the common prefix for files associated with a run.
get_run_param_dump_file_prefix	Get the prefix to a file in the run directory that the app will dump parameter data to.
get_run_param_load_file_prefix	Get the prefix to a file in the run directory that the app will load parameter data from.
take_snapshot	Take a JSONLikeDirSnapShot.

classmethod get_commands_file_name(block_act_key, shell)

Get the name of the file containing commands.

Parameters:

• block_act_key (BlockActionKey) –

• shell (Shell) –

Return type:

str

static get_run_file_prefix(block_act_key)

Get the common prefix for files associated with a run.

Parameters:

block_act_key (BlockActionKey) –

Return type:

str

classmethod get_run_param_dump_file_prefix(block_act_key)

Get the prefix to a file in the run directory that the app will dump parameter data to.

Parameters:

block_act_key (BlockActionKey) –

Return type:

str

classmethod get_run_param_load_file_prefix(block_act_key)

Get the prefix to a file in the run directory that the app will load parameter data from.

Parameters:

block_act_key (BlockActionKey) –

Return type:

str

classmethod take_snapshot(root_path=None)

Take a JSONLikeDirSnapShot.

This includes command files that are invoked by jobscripts, the app log file, and the app standard out/error file.

Return type:

dict[str, Any]