reclaim.static_features package

Subpackages

• reclaim.static_features.utils package
  • reclaim.static_features.utils.aec_shape module
    • concavity_index()
    • mean_curvature()
    • mean_slope()
  • reclaim.static_features.utils.area_perimeter module
    • calculate_length_area_meters()
  • reclaim.static_features.utils.catchment_agreggate module
  • reclaim.static_features.utils.flow_length module
    • clean_narrow_necks()
    • compute_adaptive_buffer_dist()
    • compute_initial_tolerance()
    • create_continuous_linestring()
    • extract_valid_lines()
    • filter_narrow_removed_parts()
    • find_actual_flow_path()
    • find_optimal_resolution()
    • get_largest_polygon()
    • plot_flow_length_with_reservoir()
    • shape_index()
    • simplify_geometry()
    • simplify_path()
    • widen_narrow_parts()

reclaim.static_features.catchment_static module

reclaim.static_features.reservoir_static module

reclaim.static_features.reservoir_static.reservoir_based_static_features(obc: float = None, hgt: float = None, mrb: str = None, lat: float = None, lon: float = None, by: int = None, reservoir_polygon: Polygon = None, inlet_point: Point = None, resolution: float = None, aec_df: DataFrame = None, savepath_flowpath_fig: str = None) → DataFrame

Compute reservoir-based features for RECLAIM input dataset.

Parameters:

• obc (float, optional) – Original Built Capacity (MCM), original design capacity of the reservoir.

• hgt (float, optional) – Dam height (meters).

• mrb (str, optional) – Major river basin name.

• lat (float, optional) – Latitude of dam location (degrees).

• lon (float, optional) – Longitude of dam location (degrees).

• by (int, optional) – Build year of the reservoir.

• reservoir_polygon (shapely.geometry.Polygon, optional) – Reservoir polygon geometry used to compute area and perimeter.

• dam_point (shapely.geometry.Point, optional) – Location of the dam.

• inlet_point (shapely.geometry.Point, optional) – Reservoir inlet location (if not provided, estimated internally).

• resolution (float, optional) – Spatial resolution used in flow length calculations.

• aec_df (pd.DataFrame, optional) – Area-Elevation Curve dataframe with columns [‘area’, ‘elevation’].

• savepath_flowpath_fig (str, optional) – Path to save the flow path figure, optional.

Returns:

A single-row DataFrame with the following columns: - OBC: Original Built Capacity (MCM) - HGT: Dam Height (m) - MRB: Major River Basin - LAT: Latitude (deg) - LON: Longitude (deg) - BY: Build Year - RA: Reservoir Area (sq km) - RP: Reservoir Perimeter (km) - FL: Flow Length (km) - AECS: AEC Mean Slope (km2/m) - AECC: AEC Mean Curvature (km2/m2) - AECI: AEC Concavity Index (DL)

Return type:

pd.DataFrame