gsflow.builder.prms_builder Module¶
-
class
gsflow.builder.prms_builder.
PrmsBuilder
(stream_data_obj, cascades_obj, modelgrid, dem, hru_type=None, hru_subbasin=None, defaults=None)[source]¶ Class for building PrmsParameter object using built in Defaults
PrmsBuilder builds a PrmsParameter object using default values from gsflow.builder.Defaults or a user supplied Defaults object.
The user can then edit the PrmsParameter object to customize their model runs and add climate, land cover, and soils information.
- Parameters
- stream_data_objgsflow.builder._StreamsObj
stream data from the flow accumulation make_streams() method
- cascade_objgsflow.builder._Cascades object
cascade data object from the flow accumulation get_cascades() method
- modelgridflopy.discretization.StructuredGrid object
- hru_typenp.ndarray
hru_type array
- hru_subbasinnp.ndarray
hru_subbasin array
- defaultsgsflow.builder.Defaults object
optional gsflow.builder.Defaults object to build the PrmsParameters object with.
Methods
build
(self[, name, area_conv])Method to build a PrmsParameters object that can be used to build a GSFLOW or PRMS model
-
build
(self, name=None, area_conv=0.000247105)[source]¶ Method to build a PrmsParameters object that can be used to build a GSFLOW or PRMS model
- Parameters
- namestr
name of the parameter file
- area_convfloat
conversion factor from model units sq. to arces
- Returns
- gsflow.prms.parameters.PrmsParameters object