ramp_utils.read_config

ramp_utils.read_config(config_file, filter_section=None, check_requirements=True)

Read and parse the configuration file for RAMP.

Parameters

config_file: str

Path to the YAML configuration file.

filter_sectionNone, str, or list of str, default is None

To restrict the configuration to particular field. By default all the configuration file is read. The available sections of the configuration is:

• ‘sqlalchemy’: contain the information related to the database;

check_requirements: bool, default is True

Whether to check that all minimum configuration parameters were read from the configuration file.

Returns

configdict

Configuration parsed as a dictionary.