gsflow.output.prms_output Module

class gsflow.output.prms_output.StatVar(statvar_file, statvar_names=None, statvar_elements=None)[source]

Class to read in the statvar file into a pandas Dataframe

Parameters
statvar_filestr

name of the stat var file

statvar_nameslist, optional

statvar_names will be determined from file if None

statvar_elementslist, optional

statvar_elements will be determined from file if None

Examples

load from a control file

>>> import gsflow
>>> control = gsflow.ControlFile.load_from_file("gsflow.gsflow")
>>> stats = StatVar.load_from_control_object(control)

load from a statistics file

>>> stats = StatVar("mystatvar.txt")

Methods

load_from_control_object(control)

Load the statvar from a ControlFile object

plot(self)

Built in plotting method for the statvar object.
static load_from_control_object(control)[source]

Load the statvar from a ControlFile object

Parameters
controlControlFile object
Returns
StatVar object
plot(self)[source]

Built in plotting method for the statvar object. Uses pandas built ins.