API reference

Content:

• Preprocessing
  • Data import and preprocessing
  • Simplfy Graph
  • Generate Connection Graph
• Routing Solvers
  • rsph_tree_fast()
  • UnroutedTerminalsError
  • rsph_tree()
  • find_rsph_path()
• Hydraulic Design and Optimisation
  • place_lifting_station()
  • get_max_upstream_diameter()
  • place_pump()
  • set_diameter()
  • get_downstream_junction()
  • get_junction_front()
  • reverse_bfs()
  • calculate_hydraulic_parameters()
  • peak_factor_for_population()
  • estimate_peakflow()
  • mannings_equation()
  • select_diameter()
  • min_self_cleansing_slope()
  • select_diameter_with_constraints()
  • needs_pump()
• Visualisation
  • plot_model_domain()
  • plot_sewer_attributes()
  • plot_connection_graph()
• Export
  • map_dtype_to_fiona()
  • is_list_of_tuples()
  • is_list()
  • tuple_list_to_json()
  • round_float_columns()
  • generate_schema()
  • write_gdf_to_gpkg()
  • write_gdf_to_shp()
  • export_sewer_network()
• Configuration Setting
  • Config
  • load_config()
  • config_to_dataframe()
  • view_default_settings()
  • Preprocessing settings
  • Optimization settings
  • Visualisation settings
  • Export settings
• Utilities
  • get_upstream_nodes()
  • get_path_distance()
  • points_close()
  • dedupe_coords()
  • closest_edges()
  • get_closest_edge()
  • get_closest_edge_multiple()
  • get_edge_gdf()
  • get_node_gdf()
  • get_node_keys()
  • get_edge_keys()
  • get_path_gdf()
  • get_mean_slope()
  • ckdnearest()
  • remove_third_dimension()
  • is_valid_geometry()
  • get_sewer_info()