core_lens.entities.mws#

Module for Core Lens.

Classes#

MWSEntity

Microwatershed (MWS) entity.

Module Contents#

class core_lens.entities.mws.MWSEntity(data_root: str | pathlib.Path | None = None, storage_options: dict[str, Any] | None = None)#

Bases: core_lens.base.entity.BaseEntity

Microwatershed (MWS) entity.

Backed by: - Static: mws/static (partitioned by year) - Annual: mws/annual (partitioned by year) - SubAnnual: mws/sub_annual (partitioned by basin then year)

All paths are relative to the AoI data_root.

property key_cols: list[str]#

Get the property value.

Returns:: The key columns for the entity.
Return type:: list[str]

property geometry_col: str#

Get the property value.

Returns:: The geometry column name.
Return type:: str

property static_path: str#

Get the property value.

Returns:: The relative path to the static data.
Return type:: str

property annual_path: str | None#

Get the property value.

Returns:: The relative path to the annual data.
Return type:: str | None

property sub_annual_path: str | None#

Get the property value.

Returns:: The relative path to the sub_annual data.
Return type:: str | None