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
log_file_path: logs/hpcFlow_v0.2.0a180.log
environment_sources: []
task_schema_sources: []
command_file_sources: []
parameter_sources: []
default_scheduler: direct
default_shell: bash
schedulers:
direct:
defaults: {}
shells:
bash:
defaults: {}
Validation schema#
The configuration file must conform to the following validation schema.
configs#
A mapping of string config "invocation keys" to configuration settings.
[map-value]#
config#
user_orcid#
user_name#
user_affiliation#
task_schema_sources#
shells#
parameter_sources#
machine#
A label that references the current machine. By default, this uses the return from the Python function socket.gethostname()
.
log_file_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).
log_file_level#
log_console_level#
linux_release_file#
environment_sources#
demo_data_manifest_file#
If provided, this will be used as the path to the manifest for the built-in example data files. It should point to a JSON file whose top-level keys are example data file names. Each value should be an empty map/dict or a map like: {"in_zip": "text_file.zip"}
, where text_file.zip
is the name of a zip archive that contains the example data file. This can be a local path or an fsspec URL.
demo_data_dir#
If provided, this will be used as the path to the directory containing demo data files. This can be a local path or an fsspec URL.