Utility functions

Utility functions used to facilitate constructing workflows using pycap-dss.

pycap.utilities.Q2ts(depl_pump_time, depletion_years, Q_scalar)[source]

Function to convert a scalar Q to a time series

Parameters
depl_pump_time: float

Number of days the well should be pumping from day 0

depletion_years: float

Number of years of pumping to be simulated

Q_scalar: float

Pumping rate [L**3/d]

Returns
Q: pd.Series

time-indexed time series of pumping [L**3/d]

pycap.utilities.create_timeseries_template(filename='../examples/blank_ts.csv', numyears=1, well_ids=['well1', 'well2'])[source]

create a template timeseries CSV file ready to populate with pumping rates in gallons per minute for running multiple times

Parameters
filename: str, optional

Filename in which to write the template. Defaults to ‘../examples/blank_ts.csv’.

numyears: int, optional

Number of repeated years to generate. Defaults to 1.

well_ids: list, optional

list of well identifiers which will be used as column names