water_benchmark_hub.networks

water_benchmark_hub.networks.networks

Module provides functions for loading different water distribution networks.

class water_benchmark_hub.networks.networks.Anytown

Bases: WaterDistributionNetwork

Class for loading the Anytown network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Anytown network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Anytown network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Anytown.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.BAK

Bases: WaterDistributionNetwork

Class for loading the BAK network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the BAK network. :param download_dir: Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:temp”, “/tmp/”, etc.)

Parameters:

verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the BAK network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.BIN

Bases: WaterDistributionNetwork

Class for loading the BIN network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the BIN network. :param download_dir: Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:temp”, “/tmp/”, etc.)

Parameters:

verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the BIN network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.BWSN1

Bases: WaterDistributionNetwork

Class for loading the BWSN-1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the BWSN-1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the BWSN-1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.BWSN2

Bases: WaterDistributionNetwork

Class for loading the BWSN-2 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the BWSN-2 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the BWSN-2 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Balerma

Bases: WaterDistributionNetwork

Class for loading the Balerma network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Balerma network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Balerma network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Balerma.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.CA1

Bases: WaterDistributionNetwork

Class for loading the CA1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the CA1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the CA1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.CTown

Bases: WaterDistributionNetwork

Class for loading the C-Town network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the C-Town network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, C-Town network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the CTOWN.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.CYDBP

Bases: WaterDistributionNetwork

Class for loading the Richmond network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the CY-DBP network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Richmond network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the CY-DBP.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.DMA

Bases: WaterDistributionNetwork

Class for loading the DMA network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the DMA network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the DMA network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.DTown

Bases: WaterDistributionNetwork

Class for loading the D-Town network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the D-Town network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, D-Town network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the d-town.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.ETown

Bases: WaterDistributionNetwork

Class for loading the E-Town network (also called BIWS network).

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the E-Town network.

Parameters:

download_dir (str, optional) – Path to the directory where the .inp file is stored. The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) – If True, a progress bar is shown while downloading the file. The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used. Only relevant if ‘return_scenario=True’. Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string. The default is False.

Returns:

If return_scenario is True, the E-Town network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.EXN

Bases: WaterDistributionNetwork

Class for loading the EXN network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the EXN network. :param download_dir: Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:temp”, “/tmp/”, etc.)

Parameters:

verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the EXN network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.FOWM

Bases: WaterDistributionNetwork

Class for loading the FOWM network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the FOWM network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the FOWM network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Fossolo

Bases: WaterDistributionNetwork

Class for loading the Fossolo network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Fossolo network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the Fossolo network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.FourteenPipe

Bases: WaterDistributionNetwork

Class for loading the Fourteen Pipe network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Fourteen Pipe network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the Fourteen Pipe network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.GOY

Bases: WaterDistributionNetwork

Class for loading the GOY network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the GOY network. :param download_dir: Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:temp”, “/tmp/”, etc.)

Parameters:

verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the GOY network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Hanoi

Bases: WaterDistributionNetwork

Class for loading the Hanoi networks.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, include_default_sensor_placement: bool = False, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Hanoi network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
include_default_sensor_placement (bool, optional) –
If True, a default sensor placement will be included in the returned scenario configuration.

The default is False
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Hanoi network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Hanoi.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Jilin

Bases: WaterDistributionNetwork

Class for loading the Jilin network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Jilin network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the Jilin network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KL

Bases: WaterDistributionNetwork

Class for loading the KL network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KL network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KL network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY1

Bases: WaterDistributionNetwork

Class for loading the KY1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY10

Bases: WaterDistributionNetwork

Class for loading the KY10 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY10 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY10 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY11

Bases: WaterDistributionNetwork

Class for loading the KY11 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY11 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY11 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY12

Bases: WaterDistributionNetwork

Class for loading the KY12 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY12 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY12 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY13

Bases: WaterDistributionNetwork

Class for loading the KY13 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY13 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY13 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY14

Bases: WaterDistributionNetwork

Class for loading the KY14 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY14 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY14 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY15

Bases: WaterDistributionNetwork

Class for loading the KY15 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY15 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY15 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY16

Bases: WaterDistributionNetwork

Class for loading the KY16 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY16 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY16 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY17

Bases: WaterDistributionNetwork

Class for loading the KY17 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY17 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY17 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY2

Bases: WaterDistributionNetwork

Class for loading the KY2 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY2 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY2 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY3

Bases: WaterDistributionNetwork

Class for loading the KY3 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY3 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY3 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY4

Bases: WaterDistributionNetwork

Class for loading the KY4 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY4 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY4 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY5

Bases: WaterDistributionNetwork

Class for loading the KY5 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY5 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY5 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY6

Bases: WaterDistributionNetwork

Class for loading the KY6 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY6 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY6 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY7

Bases: WaterDistributionNetwork

Class for loading the KY7 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY7 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY7 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY8

Bases: WaterDistributionNetwork

Class for loading the KY8 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY8 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY8 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KY9

Bases: WaterDistributionNetwork

Class for loading the KY9 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KY9 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KY9 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KYV18

Bases: WaterDistributionNetwork

Class for loading the KYV18 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KYV18 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KYV18 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KYV21

Bases: WaterDistributionNetwork

Class for loading the KYV21 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KYV21 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KYV21 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KYV22

Bases: WaterDistributionNetwork

Class for loading the KYV22 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KYV22 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KYV22 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KYV23

Bases: WaterDistributionNetwork

Class for loading the KYV23 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KYV23 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KYV23 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KYV24

Bases: WaterDistributionNetwork

Class for loading the KYV24 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KYV24 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KYV24 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.KYV8

Bases: WaterDistributionNetwork

Class for loading the KYV8 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the KYV8 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the KYV8 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.MarchiRural

Bases: WaterDistributionNetwork

Class for loading the Marchi Rural network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Marchi Rural network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the Marchi Rural network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Micropolis

Bases: WaterDistributionNetwork

Class for loading the Micropolois network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the MICROPOLIS network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, MICROPOLIS network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the MICROPOLIS_v1.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Modena

Bases: WaterDistributionNetwork

Class for loading the Modena network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Modena network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the Modena network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.ModifiedNineteenPipe

Bases: WaterDistributionNetwork

Class for loading the modified nineteen pipe network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the modified nineteen pipe network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the modified nineteen pipe network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.NJ1

Bases: WaterDistributionNetwork

Class for loading the NJ1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the NJ1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the NJ1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.NYC_Tunnel

Bases: WaterDistributionNetwork

Class for loading the New York City Tunnel network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the New York City Tunnel network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the New York City Tunnel network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.NineteenPipe

Bases: WaterDistributionNetwork

Class for loading the nineteen pipe network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the nineteen pipe network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the nineteen pipe network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.PA1

Bases: WaterDistributionNetwork

Class for loading the PA1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the PA1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the PA1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.PA2

Bases: WaterDistributionNetwork

Class for loading the PA2 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the PA2 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the PA2 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.RCH

Bases: WaterDistributionNetwork

Class for loading the RCH network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the RCH network. :param download_dir: Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:temp”, “/tmp/”, etc.)

Parameters:

verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the RCH network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Richmond

Bases: WaterDistributionNetwork

Class for loading the Richmond network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Richmond network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Richmond network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Richmond_standard.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.Rural

Bases: WaterDistributionNetwork

Class for loading the Rural network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Rural network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Rural network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the RuralNetwork.inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.TLN

Bases: WaterDistributionNetwork

Class for loading the TLN network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the TLN network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the TLN network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.WA1

Bases: WaterDistributionNetwork

Class for loading the WA1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the WA1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the WA1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.WCR

Bases: WaterDistributionNetwork

Class for loading the WCR network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the WCR network. :param download_dir: Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:temp”, “/tmp/”, etc.)

Parameters:

verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the WCR network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

class water_benchmark_hub.networks.networks.WaterDistributionNetwork

Bases: BenchmarkResource

Base class of water distribution networks.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

class water_benchmark_hub.networks.networks.ZhiJiang

Bases: WaterDistributionNetwork

Class for loading the Zhi Jiang network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, flow_units_id: int | None = None, verbose: bool = True, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Zhi Jiang network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, the Zhi Jiang network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.ScenarioConfig or str

water_benchmark_hub.networks.epanet_examples

Module contains the EPANET example networks.

class water_benchmark_hub.networks.epanet_examples.Net1

Bases: WaterDistributionNetwork

Class for loading the EPANET Example Network 1.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Net1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.scenario_config.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Net1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Net1.inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str

class water_benchmark_hub.networks.epanet_examples.Net2

Bases: WaterDistributionNetwork

Class for loading the EPANET Example Network 2.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Net2 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.scenario_config.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Net2 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Net2.inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str

class water_benchmark_hub.networks.epanet_examples.Net3

Bases: WaterDistributionNetwork

Class for loading the EPANET Example Network 3.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Net3 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.scenario_config.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Net3 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Net3.inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str

class water_benchmark_hub.networks.epanet_examples.Net6

Bases: WaterDistributionNetwork

Class for loading the EPANET Example Network 6.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the Net6 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.scenario_config.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, Net6 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the Net6.inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str

water_benchmark_hub.networks.ltown

Module contains the L-Town network.

class water_benchmark_hub.networks.ltown.LTown

Bases: WaterDistributionNetwork

Class for loading the L-Town networks.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, use_realistic_demands: bool = False, include_default_sensor_placement: bool = False, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the L-TOWN_v2 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
use_realistic_demands (bool, optional) –
If True, realistic demands from the BattLeDIM challenge will be included, toy demands will be included otherwise.

The default is False
include_default_sensor_placement (bool, optional) –
If True, the L-TOWN default sensor placement will be included in the returned scenario configuration.

The default is False
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, L-TOWN_v2 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str

static load_ltown_a(download_dir: str = epyt_flow.utils.get_temp_folder, use_realistic_demands: bool = False, include_default_sensor_placement: bool = False, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the L-TOWN-A network (area “A” of the L-TOWN network).

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
use_realistic_demands (bool, optional) –
If True, realistic demands from the BattLeDIM challenge will be included, toy demands will be included otherwise.

The default is False
include_default_sensor_placement (bool, optional) –
If True, the L-TOWN default sensor placement will be included in the returned scenario configuration.

The default is False
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, L-TOWN-A network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the .inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str

water_benchmark_hub.networks.bwsn_networks

Module contains the BWSN networks.

class water_benchmark_hub.networks.bwsn_networks.BWSN1

Bases: WaterDistributionNetwork

Class for loading the BWSN-1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the BWSN-1 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, BWSN-1 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the BWSN_Network_1.inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str

class water_benchmark_hub.networks.bwsn_networks.BWSN2

Bases: WaterDistributionNetwork

Class for loading the BWSN-1 network.

static get_meta_info() → dict

Gets the meta information of this resource.

Returns:: Meta info.
Return type:: dict

static load(download_dir: str = epyt_flow.utils.get_temp_folder, verbose: bool = True, flow_units_id: int | None = None, return_scenario: bool = False) → epyt_flow.simulation.ScenarioConfig | str

Loads (and downloads if necessary) the BWSN-2 network.

Parameters:

download_dir (str, optional) –
Path to the directory where the .inp file is stored.

The default is the OS-specific temporary directory (e.g. “C:\temp”, “/tmp/”, etc.)
verbose (bool, optional) –
If True, a progress bar is shown while downloading the file.

The default is True.
flow_units_id (int, optional) –
Specifies the flow units to be used in this scenario. If None, the units from the .inp file will be used.

Only relevant if ‘return_scenario=True’.

Must be one of the following EPANET toolkit constants:
- EN_CFS = 0 (cubic foot/sec)
- EN_GPM = 1 (gal/min)
- EN_MGD = 2 (Million gal/day)
- EN_IMGD = 3 (Imperial MGD)
- EN_AFD = 4 (ac-foot/day)
- EN_LPS = 5 (liter/sec)
- EN_LPM = 6 (liter/min)
- EN_MLD = 7 (Megaliter/day)
- EN_CMH = 8 (cubic meter/hr)
- EN_CMD = 9 (cubic meter/day)
The default is None.
return_scenario (bool, optional) –
If True, the network is returned as a epyt_flow.simulation.ScenarioConfig instance. Otherwise, the path to the .inp file is returned as a string.

The default is False.

Returns:

If return_scenario is True, BWSN-2 network loaded into a scenario configuration that can be passed on to epyt_flow.simulation.scenario_simulator.ScenarioSimulator. Otherwise, the path to the BWSN_Network_2.inp file is returned.

Return type:

epyt_flow.simulation.scenario_config.ScenarioConfig or str