windkit.config.get_config#

windkit.config.get_config() → Config[source]#

Return the user attribution configuration.

The configuration is read on the first call and cached for the rest of the process. Each field comes from the WINDKIT_<FIELD> environment variable if it is set and not empty, otherwise from the windkit_config.toml file in the user configuration directory. Environment variable names are case-insensitive. Unconfigured fields are None. Call get_config.cache_clear() to read the sources again.

Returns:

The configured name, email and institution.

Return type:

Config