Class to store and assess and create the meta-hq configuration file.

Attributes:
  • version (str) –

    A version name of the MetaHQ database (e.g., 'v0.1.0').

  • zenodo_doi (str) –

    A DOI of the MetaHQ database in Zenodo.

  • data_dir (str) –

    Path to where the MetaHQ data are stored.

  • logs (str) –

    Path to where the MetaHQ logs are stored.

  • ok_keys (list[str]) –

    Acceptable keys in the config.

path property

Returns /path/to/config.yaml

check()

Checks if the meta-hq config exists. Initializes if not.

is_acceptable_config()

Checks if config has correct structure.

load_config()

Loads the meta-hq config file.

load_config_str()

Loads the meta-hq config file.

make_config()

Creates the config dictionary

save_config(config)

Saves a config file.

Parameters:
  • config (dict[str, str]) –

    A config with acceptable keys.

setup()

Main setup function.

set_default()

Makes a default meta-hq config.

initialize_config()

Initialize the meta-hq config file.