Package References

Base class

class nz_stream_depletion.SD

Input aquifer parameters

SD.load_aquifer_data(sep_distance: int, pump_aq_trans: int, pump_aq_s: float, upper_aq_trans: int | None = None, upper_aq_s: float | None = None, lower_aq_trans: int | None = None, lower_aq_s: float | None = None, aqt_k: float | None = None, aqt_thick: int | None = None, aqt_s: float | None = None, stream_k: float | None = None, stream_thick: int | None = None, stream_width: int | None = None)

This method is where the physical properties of the aquifer(s) and the stream are assigned and processed. The minimum required data includes the sep_distance, pump_aq_trans, and the pump_aq_s. It will determine which stream depletion methods are available based on the input data.

Parameters:

  • sep_distance (int) – The separation distance from the pumped well to the stream.

  • pump_aq_trans (int) – The pumped (confined) aquifer transmissivity (m2/day).

  • pump_aq_s (float) – The storage coefficient of the pumped aquifer.

  • upper_aq_trans (int) – The surficial aquifer transmissivity (m2/day).

  • upper_aq_s (float) – The storage coefficient of the surficial aquifer.

  • lower_aq_trans (int) – The confined aquifer transmissivity (m2/day).

  • lower_aq_s (float) – The storage coefficient (specific storage) of the confined aquifer.

  • aqt_k (int, float) – The aquitard hydraulic conductivity (m/day).

  • aqt_s (float) – The aquitard storage coefficient.

  • aqt_thick (int) – The aquitard vertical thickness (m).

  • stream_k (int, float) – Streambed hydraulic conductivity (m/day).

  • stream_thick (int) – The streambed vertical thickness (m).

  • stream_width (int) – The streambed width (m).

Returns:

of available methods based on the input data

Return type:

list

stream depletion calcs

SD.calc_sd_ratio(n_days: int, method: str | None = None)

Calculate the stream depletion ratio for a specific number of pumping days for a specific method. If no method is provided, it will choose the highest ranking method based on the available methods.

Parameters:

  • n_days (int) – The number of pumping days.

  • method (str or None) – The stream depletion method to use. It must be one of the available methods based on the input data. None will select the highest ranking method based on the available methods.

Return type:

float

SD.calc_sd_ratios(n_days: int, method: str | None = None)

Calculate the stream depletion ratios for all pumping days up to the n_days for a specific method. If no method is provided, it will choose the highest ranking method based on the available methods.

Parameters:

  • n_days (int) – The number of pumping days.

  • method (str or None) – The stream depletion method to use. It must be one of the available methods based on the input data. None will select the highest ranking method based on the available methods.

Return type:

list

SD.calc_sd_extraction(extraction: Series, method: str | None = None)

Calculate the stream depleting extraction for all days in the extraction time series for a specific method. If no method is provided, it will choose the highest ranking method based on the available methods.

Parameters:

  • extraction (pd.Series) – The extraction time series. It must contain a pd.DatetimeIndex. If the series is irregular, it will make it regular and pad the missing times with zero. Currently, only daily data is allowed as input.

  • method (str or None) – The stream depletion method to use. It must be one of the available methods based on the input data. None will select the highest ranking method based on the available methods.

Return type:

list

API Pages