volume_contaminant_consumed#
module wntr.metrics.water_security
- volume_contaminant_consumed(demand, quality, detection_limit=0)[source]#
Volume of contaminant consumed [27].
- Parameters:
demand (pandas DataFrame) – A pandas DataFrame containing junctions demand (index = times, columns = junction names).
quality (pandas DataFrame) – A pandas DataFrame containing junctions water quality (index = times, columns = junction names).
detection_limit (float) – Contaminant detection limit
- Return type:
A pandas DataFrame containing volume consumed