epytc package

Submodules

epytc.arsenite_oxidation_arsenate_attachment_detachment module

class epytc.arsenite_oxidation_arsenate_attachment_detachment.module

Bases: object

Reynolds_number(num2, num3)

Schmidt_number(num2)

Sherwood_number(num2, num3, num4)

area_per_unit_vol()

details()

first_order_reaction(num2, num3)

hydraulic_mean_radius()

injection_pattern(num1, arr1, str1, num2, arr2, arr3, arr4)

injection_quality(arr1, arr2, str1, num2)

mass_transfer_coefficient_ars(num2, num3, num4)

mass_transfer_coefficient_cl(num2, num3)

network()

pipe_reaction(num2, num3, num4, num5, num6, num7, arr1, arr2)

reservoir_pattern(num1, str1, num2, arr1, arr2, arr3)

reservoir_quality(num1, arr1, str1, num2)

species()

tank_reaction(num2, num3, num4, num5, arr1, arr2, arr3)

variables(num2)

zero_order_reaction()

epytc.bacterial_regrowth module

class epytc.bacterial_regrowth.module

Bases: object

Reynolds_number(num2, num3)

Schmidt_number(num2)

Sherwood_number(num2, num3, num4)

details()

first_order_reaction(num2, num3)

hydraulic_mean_radius()

injection_pattern(num1, arr1, str1, num2, arr2, arr3, arr4)

injection_quality(arr1, arr2, str1, num2)

mass_transfer_coefficient(num2, num3)

network()

pipe_reaction(num2, num3, num4, num5, num6, num7, arr1, arr2)

reservoir_pattern(num1, str1, num2, arr1, arr2, arr3)

reservoir_quality(num1, arr1, str1, num2)

species()

tank_reaction(num2, num3, num4, num5, arr1, arr2, arr3)

variables(num2)

zero_order_reaction()

epytc.chlorine_decay_thms_formation module

class epytc.chlorine_decay_thms_formation.module

Bases: object

Reynolds_number(num2, num3)

Schmidt_number(num2)

Sherwood_number(num2, num3, num4)

details()

first_order_reaction(num2, num3)

hydraulic_mean_radius()

injection_pattern(num1, arr1, str1, num2, arr2, arr3, arr4)

injection_quality(arr1, arr2, str1, num2)

mass_transfer_coefficient(num2, num3)

network()

pipe_reaction(num2, num3, num4, num5, num6, num7, arr1, arr2)

reservoir_pattern(num1, str1, num2, arr1, arr2, arr3)

reservoir_quality(num1, arr1, str1, num2)

species()

tank_reaction(num2, num3, num4, num5, arr1, arr2, arr3)

variables(num2)

zero_order_reaction()

epytc.functions module

class epytc.functions.fn

Bases: object

demand_data(arr2, str1)

flow_data(arr2, str1)

incoming_links(arr1)

maximum_segments(num2, arr1, arr2)

minimum_link_diameter(num2, num3, arr1)

minimum_link_length(num2, num3, arr1)

msrt_info(num2, num3)

network()

Getting basic details of the network

Parameters:

d (EPANET object) – EPANET model

Returns:

Network details

Return type:

List

omitted_links(arr1, arr2)

omitted_nodes(arr1, arr2)

outgoing_links(arr1)

pump_names(num2, arr1)

reservoir_names(arr1, arr2)

simulation_info(num2, num3, num4)

sync_time(H, num1, num2, num3, num4, num5, num6, num7, num8, arr1, arr2)

tank_names(arr1, arr2)

tank_volume_data(arr2, str1)

time_data(arr2)

time_filter(num1, num2, num3)

valve_names(arr1)

velocity_data(arr2, str1)

epytc.main module

epytc.main.create_epytc()

Creates an object of dataclass epytc-class

Returns:

An epytc_class object

Return type:

epytc_class

class epytc.main.epytc_class(module: str, maximum_iterations_required: int, simulation_period_days: int, simulation_time_step: int, base_period_days: int, minimum_pipe_flow_velocity: float, reservoir_quality_matrix: list[list[float]], reservoir_quality_pattern: str, reservoir_quality_pattern_random_variability: float, reservoir_injection_pattern: str, reservoir_injection_pattern_random_variability: float, reservoir_injection_start_time: list[list[float]], reservoir_injection_end_time: list[list[float]], reservoir_injection_input_value: list[list[float]], injection_nodes_index: list, injection_nodes_quality_matrix: list[list[float]], injection_node_quality_pattern: str, injection_node_quality_pattern_random_variability: float, injection_node_injection_pattern: str, injection_node_injection_pattern_random_variability: float, injection_node_injection_start_time: list[list[float]], injection_node_injection_end_time: list[list[float]], injection_node_injection_input_value: list[list[float]], hyd_wq_sync_option: str)

Bases: object

base_period_days: int

hyd_wq_sync_option: str

injection_node_injection_end_time: list[list[float]]

injection_node_injection_input_value: list[list[float]]

injection_node_injection_pattern: str

injection_node_injection_pattern_random_variability: float

injection_node_injection_start_time: list[list[float]]

injection_node_quality_pattern: str

injection_node_quality_pattern_random_variability: float

injection_nodes_index: list

injection_nodes_quality_matrix: list[list[float]]

maximum_iterations_required: int

minimum_pipe_flow_velocity: float

module: str

reservoir_injection_end_time: list[list[float]]

reservoir_injection_input_value: list[list[float]]

reservoir_injection_pattern: str

reservoir_injection_pattern_random_variability: float

reservoir_injection_start_time: list[list[float]]

reservoir_quality_matrix: list[list[float]]

reservoir_quality_pattern: str

reservoir_quality_pattern_random_variability: float

simulation_period_days: int

simulation_time_step: int

epytc.main.execute_epytc(epytc: epytc_class)

Execute the epytc module

Parameters:

epytc (epytc_class) – epytc object

epytc.pfas_formation module

class epytc.pfas_formation.module

Bases: object

Reynolds_number(num2, num3)

Schmidt_number(num2)

Sherwood_number(num2, num3, num4)

details()

first_order_reaction(num2, num3)

hydraulic_mean_radius()

injection_pattern(num1, arr1, str1, num2, arr2, arr3, arr4)

injection_quality(arr1, arr2, str1, num2)

mass_transfer_coefficient(num2, num3)

network()

pipe_reaction(num2, num3, num4, num5, num6, num7, arr1, arr2)

reservoir_pattern(num1, str1, num2, arr1, arr2, arr3)

reservoir_quality(num1, arr1, str1, num2)

species()

tank_reaction(num2, num3, num4, num5, arr1, arr2, arr3)

variables(num2)

zero_order_reaction()

epytc.run module

epytc.run.run_epytc(epytc)

Module contents