saco.Dataset.find_outlet_waterbodies

Dataset.find_outlet_waterbodies(assessed_outlets_only: bool = True) → List[str]

Find IDs of “outlet” waterbodies (i.e. no relevant downstream waterbodies).

The role of this method is to help find the most downstream waterbodies. This can then be used to help identify all waterbodies upstream and so form a domain for input to the calculator or optimiser tools.

If assessed_outlets_only is False, then “outlet” waterbodies are those at the very (outer) margins of the waterbody network stored in the graph attribute. If it is True (the default) then the method identifies only the outermost waterbodies of types that are assessed for compliance (as some waterbody types near the coast are not assessed for compliance).

Parameters:

assessed_outlets_only – Whether “outlet” waterbodies should only comprise waterbodies of types that are assessed for compliance.

Returns:

List of outlet waterbody IDs.