Config

class config.AppConfig(**data)

Application configuration.

BUILDING_BATCH_PATH: str
BUILDING_PARAM_FILES: str
CLEANED_COLUMNS_FILE: str
CLEANED_COLUMNS_FILENAME: str
COSTING: str
COSTING_COLUMNS_FILE: str
COSTING_PREFIX: str
DOCKER_INPUT_PATH: str
DOCKER_OUTPUT_PATH: str
DOCKER_SRC_PATH: str
ENERGY: str
ENERGY_PARAM_FILES: str
ENERGY_PREFIX: str
ESTIMATOR_TYPE: str
FEATURES_FILE: str
FEATURE_SELECTION_BUCKET_NAME: str
FEATURE_SELECTION_FILENAME: str
MULTILAYER_PERCEPTRON: str
OHE_FILE: str
OHE_FILENAME: str
PREPROCESSING_BUCKET_NAME: str
PREPROCESSING_FILENAME: str
RANDOM_FOREST: str
RANDOM_SEED: str
RUNNING_AGGREGATED_RESULTS_FILENAME: str
RUNNING_COSTING_RESULTS_FILENAME: str
RUNNING_DAILY_RESULTS_FILENAME: str
RUN_BUCKET_NAME: str
SCALERX_FILENAME: str
SCALERY_FILENAME: str
SCALER_X_FILE: str
SCALER_Y_FILE: str
SELECTED_MODEL_TYPE: str
SIMULATION_END_DATE: str
SIMULATION_START_DATE: str
TRAINED_MODEL_FILE: str
TRAINED_MODEL_FILENAME_MLP: str
TRAINED_MODEL_FILENAME_RF: str
TRAINING_BUCKET_NAME: str
TRAINING_RESULTS_FILENAME: str
TRAIN_BUCKET_NAME: str
USE_DROPOUT: str
USE_UPDATED_MODEL: str
VAL_BUILDING_PARAM_FILE: str
VAL_ENERGY_PARAM_FILE: str
WEATHER_BUCKET_NAME: str
WEATHER_DATA_STORE: AnyHttpUrl
class config.Settings(_env_file='<object object>', _env_file_encoding=None, _env_nested_delimiter=None, _secrets_dir=None, **values)

Application settings. All of these can be set by the environment to override anything coded here.

APP_CONFIG: AppConfig
class Config
env_prefix = 'BTAP_'
extra = 'ignore'
config.create_directory(path)

Given a path, create the directory if it exists

Parameters:

path (str) – directory to be created

Return type:

None

config.get_config(config_file)

Load the specified configuration file.

Parameters:

config_file (str) – Path to the config file relative to the default bucket.

Returns:

Dictionary of configuration information.

config.json_config_settings_source(settings)

Load credentials from the file system. No longer used but retained in case needed in the future

Return type:

Dict[str, Any]