pypeec.config

Module managing the configuration of the program.

• The config variables are accessed with attributes.

• First the default configuration is loaded (“pypeec/data/config.yaml”).

• Afterward, a custom file can be loaded via the environment variable (“PYPEEC”).

Warning

• The configuration is loaded by different PyPEEC modules.

• The configuration cannot be updated after the initialization.

pypeec.config.get_file_config()

Return the loaded configuration file.

Returns:

file_config – String with the loaded configuration file.

Return type:

string

pypeec.config.get_data_config()

Return the loaded configuration data.

Returns:

data_config – Dict with the loaded configuration data.

Return type:

dict

pypeec.config.get_version()

Get the PyPEEC version.

Returns:

version – String with the PyPEEC version.

Return type:

string