hpcflow.app.RunDirAppFiles#

class hpcflow.app.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_log_file_name`	File name for the app log file.
`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.
`get_std_file_name`	File name for stdout and stderr streams from the app.
`take_snapshot`	Take a `JSONLikeDirSnapShot`, and process to ignore files created by the app.

classmethod get_commands_file_name(js_idx, js_action_idx, shell)#

Get the name of the file containing commands.

Parameters:

Return type:

str

classmethod get_log_file_name()#

File name for the app log file.

static get_run_file_prefix(js_idx, js_action_idx)#

Get the common prefix for files associated with a run.

Parameters:

Return type:

str

classmethod get_run_param_dump_file_prefix(js_idx, js_action_idx)#

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

Parameters:

Return type:

str

classmethod get_run_param_load_file_prefix(js_idx, js_action_idx)#

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

Parameters:

Return type:

str

classmethod get_std_file_name()#

File name for stdout and stderr streams from the app.

classmethod take_snapshot()#

Take a JSONLikeDirSnapShot, and process to ignore files created by the app.

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