Configuration file#

Configurable settings that can be set within the configuration file are listed here.

Default config file#

configs:
  default:
    invocation:
      environment_setup:
      match: {}
    config:
      machine: HOSTNAME
      telemetry: true
      log_file_path: logs/hpcFlow_v0.2.0a46.log
      environment_sources: []
      task_schema_sources: []
      command_file_sources: []
      parameter_sources: []

Validation schema#

The configuration file must conform to the following validation schema.

configs#

type: dict (key: str) (value: dict)
Condition: ConditionAnd(ValueDataType.equal_to(value=<class 'dict'>), Value.keys_is_instance(<class 'str'>))

A mapping of string config "invocation keys" to configuration settings.

[map-value]#

type: dict, optional
Condition: ConditionAnd(ValueDataType.equal_to(value=<class 'dict'>), Value.required_keys('invocation', 'config'))

config#

type: dict, required
Condition: Value.forbidden_keys('config_directory', 'config_file_name', 'config_file_path', 'config_file_contents', 'config_invocation_key', 'config_schemas', 'invoking_user_id', 'host_user_id', 'host_user_id_file_path', 'config_callback', 'get_all', 'get', 'set', 'unset', 'save', 'reload')
task_index_dtype#
optional
Condition: None
element_index_dtype#
optional
Condition: None
parameter_index_dtype#
optional
Condition: None
num_task_group_nesting_levels#
optional
Condition: None
num_zarr_objects_nesting_levels#
optional
Condition: None
max_num_zarr_objects_per_dir#
optional
Condition: None
environment_sources#
type: list (of: str | path), required
Condition: ValueDataType.equal_to(value=<class 'list'>)
command_file_sources#
type: list (of: str | path), required
Condition: ValueDataType.equal_to(value=<class 'list'>)
parameter_sources#
type: list (of: str | path), required
Condition: ValueDataType.equal_to(value=<class 'list'>)
task_schema_sources#
type: list (of: str | path), required
Condition: ValueDataType.equal_to(value=<class 'list'>)
log_console_level#
type: str, ('notset' | 'debug' | 'info' | 'warning' | 'error' | 'critical'), optional
Condition: ConditionAnd(ValueDataType.equal_to(value=<class 'str'>), Value.in_(value=['notset', 'debug', 'info', 'warning', 'error', 'critical']))
log_file_level#
type: str, ('notset' | 'debug' | 'info' | 'warning' | 'error' | 'critical'), optional
Condition: ConditionAnd(ValueDataType.equal_to(value=<class 'str'>), Value.in_(value=['notset', 'debug', 'info', 'warning', 'error', 'critical']))
log_file_path#
type: str | path, optional
Condition: Value.is_instance(<class 'str'>, <class 'pathlib.Path'>)

File path to the app log file. The variables <<app_name>> and <<app_version>> are available to be used in this option, which resolve to the app name and version, respectively.

The file path may be nested in non-existent directories, in which case those directories will be generated. If specified as a relative path, the path will be resolved relative to the config directory (the directory that contains the config file).

linux_release_file#
type: str, optional
Condition: ValueDataType.equal_to(value=<class 'str'>)
user_affiliation#
type: str, optional
Condition: ValueDataType.equal_to(value=<class 'str'>)
user_orcid#
type: str, optional
Condition: ValueDataType.equal_to(value=<class 'str'>)
user_name#
type: str, optional
Condition: ValueDataType.equal_to(value=<class 'str'>)
machine#
type: str, required
Condition: ValueDataType.equal_to(value=<class 'str'>)

A label that references the current machine. By default, this uses the return from the Python function socket.gethostname().

telemetry#
type: bool, required
Condition: ValueDataType.equal_to(value=<class 'bool'>)

invocation#

type: dict, required
Condition: Value.allowed_keys('environment_setup', 'match')
match#
type: dict, optional
Condition: ValueDataType.equal_to(value=<class 'dict'>)
environment_setup#
optional
Condition: None