easymore_basinsubset.py is broken with EASYMORE v1.0 update

[cooperalbano]

EASYMORE v1.0 removes the "get_all_downstream" and "get_all_upstream" functions upon which the basin subset script relies.

The script should be updated to subset the shapefiles without EASYMORE or by using whatever functions may have replaced the above.

@kasra-keshavarz
@AlaBahrami

[kasra-keshavarz]

Use the following function instead:

import geopandas as gpd
import networkx as nx
from typing import (
    Union,
)

def find_upstream(
    gdf: gpd.GeoDataFrame,
    target_id: Union[str, int, ...],
    main_id: str,
    ds_main_id: str,
) -> set[...]:
    '''Find "ancestors" or upstream segments in a river network given
    in the from of a geopandas.GeoDataFrame `gdf`
    
    Parameters:
    -----------
    gdf: geopandas.GeoDataFrame
        GeoDataFrame of river segments including at least three pieces
        of information: 1) geometries of segments, 2) segment IDs, and
        3) downstream segment IDs
    target_id: str, int, or any other data type as included in `gdf`
        Indicating the target ID anscestor or upstream of which is
        desired
    main_id: str
        String defining the column of element IDs in the input geopandas
        dataframe
    ds_main_id: str
        String defining the column of downstream element IDs in the
        input geopandas dataframe
    
    Returns:
    --------
    nodes: set
        IDs of nodes being upstream or anscestor of the `target_id`
    
    '''
    # creating a DiGraph out of `gdf` object
    riv_graph = nx.from_pandas_edgelist(gdf, source=main_id, target=ds_main_id, create_using=nx.DiGraph)
    
    # return nodes in a list
    nodes = nx.ancestors(riv_graph, target_id)
    
    return nodes

Let me know if you have any other problems.

[AlaBahrami]

Thanks @kasra-keshavarz for your update.

@cooperalbano, would you try the new update and see if it works. Please update the code in the case you dont have any issues.

Thanks

[cooperalbano]

Thanks @kasra-keshavarz. I am getting this error:

Traceback (most recent call last):
  File "easymore_basinsubset_fix.py", line 179, in <module>
    target_id: Union[str, int, ...],
  File "/usr/lib/python3.8/typing.py", line 261, in inner
    return func(*args, **kwds)
  File "/usr/lib/python3.8/typing.py", line 358, in __getitem__
    parameters = tuple(_type_check(p, msg) for p in parameters)
  File "/usr/lib/python3.8/typing.py", line 358, in <genexpr>
    parameters = tuple(_type_check(p, msg) for p in parameters)
  File "/usr/lib/python3.8/typing.py", line 149, in _type_check
    raise TypeError(f"{msg} Got {arg!r:.100}.")
TypeError: Union[arg, ...]: each arg must be a type. Got Ellipsis.

[kasra-keshavarz]

Please remove the type hints and try again.

This is a non-critical error which I think is 99% related to your version of Python. This works well on Python 3.11. Let me know if you still are getting errors.

[cooperalbano]

Thanks @kasra-keshavarz, this worked. I added a single line:

    # return nodes in a list
    nodes = nx.ancestors(riv_graph, target_id)
    nodes.add(target_id)

    return nodes

to include the outlet.

[cooperalbano]

@AlaBahrami Fix applied.

#32

[kasra-keshavarz]

Glad it's working fine! Let me know if there is any other issues.

Cheers