extent_contaminant#

module wntr.metrics.water_security

extent_contaminant(quality, flowrate, wn, detection_limit=0)[source]#

Extent of contaminant in the pipes [28].

Parameters:

  • quality (pandas DataFrame) – A pandas DataFrame containing node water quality (index = times, columns = node names).

  • flowrate (pandas DataFrame) – A pandas DataFrame containing pipe flowrate (index = times, columns = pipe names).

  • wn (wntr WaterNetworkModel) – Water network model. The water network model is needed to get pipe length, and pipe start and end node.

  • detection_limit (float) – Contaminant detection limit.

Return type:

A pandas Series with extent of contamination (m)