pywatershed.PRMSChannelFlowNodeMaker#

class pywatershed.PRMSChannelFlowNodeMaker(discretization, parameters, calc_method=None, verbose=None)[source]#

A FlowNodeMaker for PRMSChannelFlowNodes.

See PRMSChannelFlowNode for additional details and the required parameters.

See FlowGraph for discussion and a worked example. The notebook examples/06_flow_graph_starfit.ipynb highlights adding a StarfitFlowNode a FlowGraph otherwised comprised of PRMSChannelFlowNodes using the helper functions prms_channel_flow_graph_to_model_dict() and prms_channel_flow_graph_postprocess().

__init__(discretization, parameters, calc_method=None, verbose=None)[source]#

Instantiate a PRMSChannelFlowNodeMaker.

Parameters:
  • discretization (Parameters) – a discretization of class Parameters

  • parameters (Parameters) – a parameter object of class Parameters

  • calc_method (Literal['numba', 'numpy']) – one of [“fortran”, “numba”, “numpy”]. None defaults to “numba”.

  • verbose (bool) – Print extra information or not?

Methods

__init__(discretization, parameters[, ...])

Instantiate a PRMSChannelFlowNodeMaker.

get_dimensions()

Get a tuple of dimension names for this PRMSChannelFlowNodeMaker.

get_node(control, index)

Instantiate FlowNode at a given index.

get_parameters()

Get a tuple of parameter names for PRMSChannelFlowNodeMaker.

static get_dimensions()[source]#

Get a tuple of dimension names for this PRMSChannelFlowNodeMaker.

Return type:

tuple

get_node(control, index)[source]#

Instantiate FlowNode at a given index.

Parameters:
  • control – A Control object.

  • index – The index in the discretization and parameter data to use when instantiating a FlowNode.

Return type:

PRMSChannelFlowNode

static get_parameters()[source]#

Get a tuple of parameter names for PRMSChannelFlowNodeMaker.

Return type:

tuple