Package index

hy S3 Object

hy(): Create a hy Fabric S3 Object
is.hy(): Is Valid hy Class?
hy_topo: hy_topo: self-referencing edge list
hy_leveled: hy_leveled: enriched self-referencing edge list
hy_node: hy_node: bipartite feature-and-nexus graph
hy_flownetwork: hy_flownetwork: non-dendritic junction table
hy_network_type(): What representation pattern does this network use?
hy_capabilities(): What operations are available for this network?
is_dendritic(): Is the network dendritic?
hy_reverse(): Reverse hy to Original Names
hydroloom_names(): Get or Set Hydroloom Names
hydroloom_name_definitions: Hydroloom Name Definitions
align_names(): Align Names to Hydroloom Convention

Utility Functions

check_hy_graph(): Check hy Graph
check_valid(): Check and Repair Geometry Validity
dissolve_polygons(): Dissolve Polygons
fix_flowdir(): Fix Flow Direction
get_node(): Get Line Node
st_compatibalize(): Make Spatial Inputs Compatible
rename_geometry(): Rename Geometry

Network Graph and Topology Functions

sort_network(): Sort Network
subset_network(): Subset Network
add_topo_sort(): Add topo_sort
add_toids(): Add Downstream IDs
make_attribute_topology(): Make Attribute Topology
make_node_topology(): Make Node Topology from Edge Topology
to_flownetwork(): To Flownetwork
make_index_ids(): Make Index ids
get_bridge_flowlines(): Get Bridge Flowlines

Network Attributes

add_divergence(): Add Divergence Attribute
add_return_divergence(): Add Return Divergence
add_levelpaths(): Add Level Paths
add_pathlength(): Add Path Length
add_pfafstetter(): Add Pfafstetter Codes
add_streamlevel(): Add Streamlevel
add_streamorder(): Add Streamorder

navigate_network_dfs(): Navigate all Paths Depth First
navigate_connected_paths(): Navigate Connected Paths
navigate_hydro_network(): Navigate Hydro Network
accumulate_downstream(): Accumulate Variable Downstream

Indexing and Linear Referencing

index_points_to_lines(): Index Points to Lines
index_points_to_waterbodies(): Index Points to Waterbodies
disambiguate_indexes(): Disambiguate Flowline Indexes
get_hydro_location(): Get Hydro Location
get_partial_length(): Get Partial Flowpath Length
rescale_measures(): Rescale Aggregate id Measure to id Measure
add_measures(): Add aggregate id measures to flowlines

Domain Decomposition

Experimental. Decompose a flowline network into per-segment domains for distributed accumulation and recompose results back to the source network. API may change.

decompose_network(): Decompose a network into domains
recompose(): Recompose a domain decomposition by accumulating an attribute downstream
hy_domain(): Construct a hy_domain
domain_decomposition: Domain decomposition object
print(<domain_decomposition>): Print a domain_decomposition
validate_decomposition(): Validate a domain decomposition
get_domain(): Get a domain by id
get_domain_for_catchment(): Look up the domain containing a catchment
get_domain_graph(): Get the inter-domain edge list from a decomposition
get_domain_connectivity(): Get a basin's extensive network overlay
get_nexus_registry(): Get the nexus registry from a decomposition
get_overrides(): Get the overrides table from a decomposition
set_containment(): Declare containment between domains
get_containing_domain(): Look up a domain's containing domain
is_leaf_domain(): Test whether a domain is a leaf
is_root_domain(): Test whether a domain is the root of its basin
is_stem_domain(): Test whether a domain is a stem

Deprecated

make_fromids(): DEPRECATED Convert "to" index ids to "from" index ids
format_index_ids(): DEPRECATED: Format Index ids

hy S3 Object

Utility Functions

Network Graph and Topology Functions

Network Attributes

Network Navigation and Accumulation

Indexing and Linear Referencing

Domain Decomposition

Deprecated