hpcflow.sdk.app.App#

class hpcflow.sdk.app.App(*args, **kwargs)#

Bases: BaseApp

Class from which to instantiate downstream app objects (e.g. MatFlow).

Methods

get_info

get_parameter_task_schema_map

Get a dict mapping parameter types to task schemas that input/output each parameter.

load_builtin_template_component_data

load_config

load_template_components

perm_error_retry

Return a decorator for retrying functions on permission and OS errors that might be associated with cloud-storage desktop sync.

reload_config

reload_template_components

template_components_from_json_like

Attributes

API_logger

CLI_logger

command_files

config

config_logger

envs

is_config_loaded

is_template_components_loaded

log

logger

parameters

persistence_logger

run_time_info

runtime_info_logger

scripts

task_schemas

template_components

property API_logger: Logger#
property CLI_logger: Logger#
property command_files: CommandFilesList#
property config: Config#
property config_logger: Logger#
property envs: EnvironmentsList#
get_info()#
Return type:

Dict[str, Any]

get_parameter_task_schema_map()#

Get a dict mapping parameter types to task schemas that input/output each parameter.

Return type:

Dict[str, List[List]]

property is_config_loaded: bool#
property is_template_components_loaded: bool#
classmethod load_builtin_template_component_data(package)#
Return type:

Dict[str, List | Dict]

load_config(config_dir=None, config_invocation_key=None, **overrides)#
Return type:

None

load_template_components(warn=True)#
Return type:

None

property log: AppLog#
property logger: Logger#
property parameters: ParametersList#
perm_error_retry()#

Return a decorator for retrying functions on permission and OS errors that might be associated with cloud-storage desktop sync. engine operations.

property persistence_logger: Logger#
reload_config(config_dir=None, config_invocation_key=None, **overrides)#
Return type:

None

reload_template_components(warn=True)#
Return type:

None

property run_time_info: RunTimeInfo#
property runtime_info_logger: Logger#
property scripts#
property task_schemas: TaskSchemasList#
property template_components: Dict[str, ObjectList]#
template_components_from_json_like(json_like)#
Return type:

None