Attributes¶
Location¶
Location is a frozen dataclass that holds the physical position of a station.
It contains three numeric fields: altitude (metres above sea level), longitude
(decimal degrees), and latitude (decimal degrees).
colombia_hydrodata.attributes.Location
dataclass
¶
Geographic location attributes of a station.
Attributes:
| Name | Type | Description |
|---|---|---|
altitude |
float
|
Elevation of the station above sea level, in meters. |
longitude |
float
|
Longitudinal coordinate of the station, in decimal degrees. |
latitude |
float
|
Latitudinal coordinate of the station, in decimal degrees. |
__str__()
¶
Return a human-readable string representation of the location.
Returns:
| Type | Description |
|---|---|
str
|
A formatted string showing altitude, longitude, and latitude. |
from_stations_df(station_id)
classmethod
¶
Construct a Location instance from station location data.
Fetches location data for the given station ID and uses it to populate the altitude, longitude, and latitude fields.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
station_id
|
str
|
The unique identifier of the station. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
A new Location instance populated with the station's location data. |
options: show_source: false show_root_heading: true show_symbol_type_heading: true show_symbol_type_toc: true members_order: source
Hydrographic¶
Hydrographic describes the hydrological context of a station within Colombia's river basin hierarchy, including the area, zone, sub-zone, and catchment to which it belongs. These attributes are useful for grouping or filtering stations by watershed.
colombia_hydrodata.attributes.Hydrographic
dataclass
¶
Hydrographic classification attributes of a station.
Attributes:
| Name | Type | Description |
|---|---|---|
hydrographic_area |
str
|
The broad hydrographic area the station belongs to. |
hydrographic_zone |
str
|
The hydrographic zone within the area. |
hydrographic_subzone |
str
|
The hydrographic subzone within the zone. |
__str__()
¶
Return a human-readable string representation of the hydrographic data.
Returns:
| Type | Description |
|---|---|
str
|
A formatted string showing the hydrographic area, zone, and subzone. |
from_stations_df(station_id)
classmethod
¶
Construct a Hydrographic instance from station hydrographic data.
Fetches hydrographic data for the given station ID and uses it to populate the area, zone, and subzone fields.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
station_id
|
str
|
The unique identifier of the station. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
A new Hydrographic instance populated with the station's |
Self
|
hydrographic classification data. |
options: show_source: false show_root_heading: true show_symbol_type_heading: true show_symbol_type_toc: true members_order: source
Variable¶
Variable is a frozen dataclass representing a single hydrometeorological time series
available at a station. It carries three fields: param (the physical parameter family,
e.g. "CAUDAL"), label (the Aquarius dataset label, e.g. "HIS_Q_MEDIA_D"), and
id (the numeric Aquarius dataset identifier used to fetch the raw data).
colombia_hydrodata.attributes.Variable
dataclass
¶
A measured hydrometeorological variable.
Attributes:
| Name | Type | Description |
|---|---|---|
param |
str
|
Short parameter code identifying the type of variable
(e.g. |
label |
str
|
Descriptive label for the variable, typically including sensor or aggregation details. |
id |
int
|
Numeric identifier for the variable as used by the data source. |
__str__()
¶
Return an uppercase string combining the param and label.
Returns:
| Type | Description |
|---|---|
str
|
A string of the form |
options: show_source: false show_root_heading: true show_symbol_type_heading: true show_symbol_type_toc: true members_order: source