gsflow.param_base Module

class gsflow.param_base.ParameterBase(records_list, name=None, model_dir=None, header=None)

Base class for parameter based files within GSFLOW

Parameters

records_listlist

list of ParameterRecord objects

namestr, optional

parameter file name

model_dirstr, optional

parameter file directory

headerstr, optional

header for the parameter file

Attributes

record_names

Methods

add_record(self, recobj[, where, after])	Generalized method to add a record to a record list
get_record(self, name, rectype)	Method to get records
get_values(self, name)	Method to get record values
remove_record(self, name)	Method to remove a record
set_values(self, name, values)	Method to set new values to a record

add_record(self, recobj, where=None, after=None)

Generalized method to add a record to a record list

Parameters

recobjRecordBase object

ParameterRecord or ControlRecord

whereint

index location to insert record

afterint

index location - 1 to insert record

get_record(self, name, rectype)

Method to get records

Parameters

namestr

name of record

rectypeclass object

ParameterRecord or ControlRecord

Returns

RecordBase object

get_values(self, name)

Method to get record values

Parameters

namestr

name of record

Returns

np.ndarray

remove_record(self, name)

Method to remove a record

Parameters

namestr

parameter name

set_values(self, name, values)

Method to set new values to a record

Parameters

namestr

record name

valueslist

list of values