water_benchmark_hub.bwdf
water_benchmark_hub.bwdf.bwdf
Module provides access to the Battle of Water Demand Forecasting (BWDF) benchmark.
- class water_benchmark_hub.bwdf.bwdf.BWDF
Bases:
BenchmarkResourceThe Battle of Water Demand Forecasting (BWDF), organized by S. Alvisi, M. Franchini, V. Marsili, F. Mazzoni, E. Salomons , is the 10th in the series of “Battle Competitions” dating back to the Battle of the Water Networks (BWN) in 1985. It took place during the 3nd International Joint Conference on Water Distribution System Analysis (WDSA) and Computing and Control in the Water Industry (CCWI), held in Ferrara, Italy in July 2024.
This module provides functions for loading the original competition data set
load_data().- static get_meta_info() dict
Gets the meta information of this resource.
- Returns:
Meta info.
- Return type:
dict
- static load_data(download_dir: str | None = None, verbose: bool = True) pandas.DataFrame | Any
Loads and returns the original competition data.
Note
Be aware of NaNs in the data!
- Parameters:
download_dir (str, optional) –
Path to the data files – if None, the temp folder will be used. If the path does not exist, the data files will be downloaded to the given path.
The default is None.
verbose (bool, optional) –
If True, a progress bar is shown while downloading files.
The default is True.
- Returns:
Original competition data.
- Return type: