saco.Dataset.identify_upstream_waterbodies

Dataset.identify_upstream_waterbodies(outlet_waterbodies: str | List[str]) → List[str]

Identify all waterbodies upstream of (and including) a waterbody(s).

This method can be used to define a domain for the calculator or optimiser tools. Just one list is returned, no matter how many outlet_waterbodies are provided as an argument to the method. The outlet_waterbodies supplied do not have to be at the margins of the waterbody network (i.e. the method can identify catchments upstream of any waterbody(s)).

Parameters:

outlet_waterbodies – One or more waterbodies.

Returns:

List of waterbodies upstream of (all) outlet_waterbodies (list includes the outlet_waterbodies themselves).