Skip to content

CAMELS-PE

Overview

CAMELS-PE is the Peru hydrological dataset implementation, providing CAMELS-style daily hydrometeorological time series and catchment attributes for 136 catchments in Peru (Llauca et al., 2026).

Dataset Information

  • Region: Peru
  • Module: hydrodataset.camels_pe
  • Class: CamelsPe
  • Backend: aqua_fetch.CAMELS_PE (available since aqua-fetch 1.1.0)
  • Download source: Zenodo 21195425 (~121 MB)

Features

Static Attributes

Static catchment attributes include: - Basin area - Mean precipitation - Topographic characteristics - Land cover information - Soil properties - Geological and human-intervention attributes - Gauge metadata (name, region, record period)

Dynamic Variables

Timeseries variables available: - Streamflow (observed) - Precipitation - Temperature (min, max, mean) - Potential evapotranspiration - Solar radiation - Vapor pressure

Usage

Basic Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
from hydrodataset.camels_pe import CamelsPe
from hydrodataset import resolve_data_path

# Initialize dataset (first access triggers a ~121 MB download)
data_path = resolve_data_path("camels_pe")
ds = CamelsPe(data_path)

# Get basin IDs
basin_ids = ds.read_object_ids()
print(f"Number of basins: {len(basin_ids)}")

# Check available features
print("Static features:", ds.available_static_features)
print("Dynamic features:", ds.available_dynamic_features)

# Read timeseries data
timeseries = ds.read_ts_xrdataset(
    gage_id_lst=basin_ids[:5],
    t_range=ds.default_t_range,
    var_lst=["streamflow", "precipitation"]
)
print(timeseries)

# Read attribute data
attributes = ds.read_attr_xrdataset(
    gage_id_lst=basin_ids[:5],
    var_lst=["area", "p_mean"]
)
print(attributes)

Reading Specific Variables

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Read with specific time range
ts_data = ds.read_ts_xrdataset(
    gage_id_lst=basin_ids[:10],
    t_range=["1990-01-01", "1995-12-31"],
    var_lst=["streamflow", "precipitation", "temperature_mean"]
)

# Read basin area
areas = ds.read_area(gage_id_lst=basin_ids[:10])

# Read mean precipitation
mean_precip = ds.read_mean_prcp(gage_id_lst=basin_ids[:10])

Data Sources

The dataset supports multiple data sources for certain variables. Check the class documentation for available sources and use tuple notation to specify:

1
2
3
4
5
6
7
8
9
# Request specific data source
ts_data = ds.read_ts_xrdataset(
    gage_id_lst=basin_ids[:5],
    t_range=["1990-01-01", "1995-12-31"],
    var_lst=[
        ("precipitation", "pisco"),  # Specify PISCO source
        "streamflow"  # Use default source
    ]
)

API Reference

hydrodataset.camels_pe.CamelsPe

Bases: HydroDataset

CAMELS-PE dataset reader.

Thin wrapper over the aqua_fetch CAMELS_PE class (available since aqua-fetch 1.1.0). Data is downloaded/extracted by aqua_fetch to {root}/CAMELS_PE/CAMELS-PE_v1.0.1/CAMELS-PE/... and cached locally as camels_pe_attributes.nc / camels_pe_timeseries.nc via the base HydroDataset cache methods.

Cloud (S3/OSS) support: the base HydroDataset reads a cloud zarr store at s3://bucket/zarr/camels_pe_*.zarr and, when it is missing, calls cache_*_to_zarr to auto-generate it. CamelsPe implements these by reading the raw CAMELS-PE files directly from OSS (aqua_fetch cannot read S3), mirroring the other camels_* readers.

Source code in hydrodataset/camels_pe.py
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
class CamelsPe(HydroDataset):
    """CAMELS-PE dataset reader.

    Thin wrapper over the aqua_fetch ``CAMELS_PE`` class (available since
    aqua-fetch 1.1.0). Data is downloaded/extracted by aqua_fetch to
    ``{root}/CAMELS_PE/CAMELS-PE_v1.0.1/CAMELS-PE/...`` and cached locally as
    ``camels_pe_attributes.nc`` / ``camels_pe_timeseries.nc`` via the base
    ``HydroDataset`` cache methods.

    Cloud (S3/OSS) support: the base ``HydroDataset`` reads a cloud zarr store
    at ``s3://bucket/zarr/camels_pe_*.zarr`` and, when it is missing, calls
    ``cache_*_to_zarr`` to auto-generate it. ``CamelsPe`` implements these by
    reading the raw CAMELS-PE files directly from OSS (aqua_fetch cannot read
    S3), mirroring the other ``camels_*`` readers.
    """

    def __init__(
        self, uri: str, region: Optional[str] = None, download: bool = False
    ) -> None:
        super().__init__(uri)
        self.region = region
        self.download = download
        if not str(uri).startswith("s3://"):
            self.aqua_fetch = CAMELS_PE(uri)

    def get_name(self):
        return "CAMELS_PE"

    def set_data_source_describe(self):
        root = os.path.join(
            str(self.data_source_dir), "CAMELS_PE", "CAMELS-PE_v1.0.1", "CAMELS-PE"
        )
        return {
            "metadata": os.path.join(root, "01_metadata"),
            "attributes": os.path.join(root, "02_attributes"),
            "timeseries": os.path.join(root, "03_timeseries"),
        }

    def download_data_source(self):
        if not hasattr(self, "aqua_fetch"):
            raise NotImplementedError("cloud download is not supported; use cache_*_to_zarr")
        self.aqua_fetch._download_camels_pe(overwrite=True)

    def read_object_ids(self) -> np.ndarray:
        """Read station IDs.

        Local: delegate to the aqua_fetch wrapper's ``stations()``. Cloud (S3):
        read ``stations.csv`` from the metadata dir directly (no aqua_fetch).
        """
        if not self._is_cloud():
            if hasattr(self, "aqua_fetch"):
                return np.sort(np.array(self.aqua_fetch.stations()))
            raise NotImplementedError
        fs = self._make_s3fs()
        rel = "CAMELS_PE/CAMELS-PE_v1.0.1/CAMELS-PE/01_metadata/stations.csv"
        uri = str(self.data_source_dir).rstrip("/")
        with fs.open(f"{uri}/{rel}".removeprefix("s3://")) as fh:
            stations = pd.read_csv(fh, dtype={"gauge_id": str})
        return np.sort(stations["gauge_id"].astype(str).to_numpy())

    def _oss_rel_base(self) -> str:
        """OSS-relative root of the extracted CAMELS-PE dataset."""
        return "CAMELS_PE/CAMELS-PE_v1.0.1/CAMELS-PE"

    def cache_attributes_to_zarr(self) -> None:
        """Generate ``camels_pe_attributes.zarr`` on OSS from the raw attribute
        files (no aqua_fetch, which cannot read S3). Mirrors the local
        attribute cache: standard columns only, basin coordinate included.
        """
        import zarr

        fs = self._make_s3fs()
        uri = str(self.data_source_dir).rstrip("/")
        base = self._oss_rel_base()

        def read_csv(rel: str, **kw) -> pd.DataFrame:
            with fs.open(f"{uri}/{rel}".removeprefix("s3://")) as fh:
                return pd.read_csv(fh, **kw)

        frames = [
            read_csv(f"{base}/01_metadata/stations.csv", index_col="gauge_id", dtype={"gauge_id": str})
        ]
        for name in (
            "topographic_attributes",
            "climatic_indices",
            "hydrological_signatures",
            "landcover_attributes",
            "geologic_attributes",
            "soil_attributes",
            "human_intervention_attributes",
        ):
            frames.append(
                read_csv(f"{base}/02_attributes/{name}.csv", index_col="gauge_id", dtype={"gauge_id": str})
            )

        df = pd.concat(frames, axis=1)
        df = df.rename(
            columns={
                "area": "area_km2",
                "elev_mean": "elev_catch_m",
                "gauge_lat": "lat",
                "gauge_lon": "long",
                "gauge_elev": "elev_gauge_m",
            }
        )
        df.index = df.index.astype(str)
        df.index.name = "basin"

        std_cols = ["area_km2", "lat", "long", "elev_gauge_m", "elev_catch_m", "p_mean", "pet_mean", "q_mean"]
        df = df[[c for c in std_cols if c in df.columns]]
        for col in df.columns:
            df[col] = pd.to_numeric(df[col], errors="coerce")

        zarr_name = self._attributes_cache_filename.replace(".nc", ".zarr")
        out, opts = self._zarr_path_and_opts(zarr_name)
        root = zarr.open_group(out, mode="w", storage_options=opts, zarr_format=2)
        ids = df.index.tolist()
        n = len(ids)
        for col in df.columns:
            arr = root.create_array(col, shape=(n,), chunks=(n,), dtype="float64")
            arr[:] = df[col].values.astype(float)
            arr.attrs["_ARRAY_DIMENSIONS"] = ["basin"]
        basin_arr = root.create_array("basin", shape=(n,), chunks=(n,), dtype=str)
        basin_arr[:] = ids
        basin_arr.attrs["_ARRAY_DIMENSIONS"] = ["basin"]
        root.attrs["coordinates"] = "basin"
        self._write_zarr_units(root, "static")
        print(f"Attributes zarr written to: {out}")

    def cache_timeseries_to_zarr(self) -> None:
        """Generate ``camels_pe_timeseries.zarr`` on OSS from the raw
        per-catchment daily files (no aqua_fetch, which cannot read S3).
        Mirrors the local timeseries cache: standard variables, basin + time
        coordinates, times stored as nanoseconds since 1970-01-01.
        """
        import zarr

        fs = self._make_s3fs()
        uri = str(self.data_source_dir).rstrip("/")
        base = self._oss_rel_base()

        rename = {
            "prec": "pcp_mm",
            "flow_obs": "q_mm_obs",
            "pet": "pet_mm",
            "tmin": "airtemp_c_min",
            "tmean": "airtemp_c_mean",
            "tmax": "airtemp_c_max",
            "vprp": "vp_hpa",
            "srad": "srad",
        }
        std_vars = ["q_mm_obs", "pcp_mm", "pet_mm", "airtemp_c_min", "airtemp_c_mean", "airtemp_c_max", "srad", "vp_hpa"]

        stations = self.read_object_ids().tolist()
        all_times = pd.date_range(self.default_t_range[0], self.default_t_range[1], freq="D")
        n, nt = len(stations), len(all_times)
        times_ns = all_times.asi8

        data = {vn: np.full((n, nt), np.nan) for vn in std_vars}
        for i, stn in enumerate(tqdm(stations, desc="CAMELS_PE zarr")):
            rel = f"{base}/03_timeseries/by_catchment/{stn}.csv"
            try:
                with fs.open(f"{uri}/{rel}".removeprefix("s3://")) as fh:
                    df = pd.read_csv(fh, index_col="date", parse_dates=True)
                df = df[~df.index.duplicated(keep="first")]
                df = df.rename(columns=rename)
                df = df.reindex(all_times)
                for vn in std_vars:
                    if vn in df.columns:
                        data[vn][i] = df[vn].values.astype(float)
            except Exception as e:
                print(f"  WARN {stn}: {e}")

        zarr_name = self._timeseries_cache_filename.replace(".nc", ".zarr")
        out, opts = self._zarr_path_and_opts(zarr_name)
        root = zarr.open_group(out, mode="w", storage_options=opts, zarr_format=2)

        for vn in std_vars:
            arr = root.create_array(vn, shape=(n, nt), chunks=(min(n, 100), min(nt, 365)), dtype="float64")
            arr[:] = data[vn]
            arr.attrs["_ARRAY_DIMENSIONS"] = ["basin", "time"]

        time_arr = root.create_array("time", shape=(nt,), chunks=(min(nt, 365),), dtype="int64")
        time_arr[:] = times_ns
        time_arr.attrs["_ARRAY_DIMENSIONS"] = ["time"]
        time_arr.attrs["units"] = "nanoseconds since 1970-01-01"
        time_arr.attrs["calendar"] = "proleptic_gregorian"

        basin_arr = root.create_array("basin", shape=(n,), chunks=(n,), dtype=str)
        basin_arr[:] = stations
        basin_arr.attrs["_ARRAY_DIMENSIONS"] = ["basin"]

        root.attrs["coordinates"] = "basin time"
        self._write_zarr_units(root, "dynamic")
        print(f"Timeseries zarr written to: {out}")

    def read_target_cols(
        self,
        object_ids=None,
        t_range_list=None,
        target_cols=None,
        gage_id_lst=None,
        t_range=None,
        **kwargs,
    ) -> np.ndarray:
        if object_ids is None:
            object_ids = gage_id_lst
        if t_range_list is None:
            t_range_list = t_range
        if target_cols is None:
            target_cols = ["streamflow"]
        ds = self.read_ts_xrdataset(
            gage_id_lst=object_ids,
            t_range=t_range_list,
            var_lst=target_cols,
            **kwargs,
        )
        return ds.to_array().transpose("basin", "time", "variable").values

    def read_relevant_cols(
        self,
        object_ids=None,
        t_range_list=None,
        relevant_cols=None,
        gage_id_lst=None,
        t_range=None,
        var_lst=None,
        forcing_type=None,
        **kwargs,
    ) -> np.ndarray:
        if object_ids is None:
            object_ids = gage_id_lst
        if t_range_list is None:
            t_range_list = t_range
        if relevant_cols is None:
            relevant_cols = var_lst
        ds = self.read_ts_xrdataset(
            gage_id_lst=object_ids,
            t_range=t_range_list,
            var_lst=relevant_cols,
            **kwargs,
        )
        return ds.to_array().transpose("basin", "time", "variable").values

    def read_constant_cols(
        self,
        object_ids=None,
        constant_cols=None,
        gage_id_lst=None,
        var_lst=None,
        **kwargs,
    ) -> np.ndarray:
        if object_ids is None:
            object_ids = gage_id_lst
        if constant_cols is None:
            constant_cols = var_lst
        ds = self.read_attr_xrdataset(
            gage_id_lst=object_ids,
            var_lst=constant_cols,
            **kwargs,
        )
        return ds.to_array().transpose("basin", "variable").values

    @property
    def _attributes_cache_filename(self):
        return "camels_pe_attributes.nc"

    @property
    def _timeseries_cache_filename(self):
        return "camels_pe_timeseries.nc"

    @property
    def default_t_range(self):
        return ["1981-01-01", "2025-12-31"]

    _subclass_static_definitions = {
        "p_mean": {"specific_name": "p_mean", "unit": "mm/day"},
        "area": {"specific_name": "area_km2", "unit": "km^2"},
        "gauge_lat": {"specific_name": "lat", "unit": "degree"},
        "gauge_lon": {"specific_name": "long", "unit": "degree"},
        "gauge_elev": {"specific_name": "elev_gauge_m", "unit": "m"},
        "elev_mean": {"specific_name": "elev_catch_m", "unit": "m"},
        "pet_mean": {"specific_name": "pet_mean", "unit": "mm/day"},
        "q_mean": {"specific_name": "q_mean", "unit": "mm/day"},
    }

    _dynamic_variable_mapping = {
        StandardVariable.STREAMFLOW: {
            "default_source": "observations",
            # NOTE: aqua-fetch 1.1.0 exposes only observed streamflow
            # (q_mm_obs); model-simulated flow_sim is intentionally dropped.
            "sources": {
                "observations": {"specific_name": "q_mm_obs", "unit": "mm/day"},
            },
        },
        StandardVariable.PRECIPITATION: {
            "default_source": "pisco",
            "sources": {
                "pisco": {"specific_name": "pcp_mm", "unit": "mm/day"},
            },
        },
        StandardVariable.POTENTIAL_EVAPOTRANSPIRATION: {
            "default_source": "pisco",
            "sources": {
                "pisco": {"specific_name": "pet_mm", "unit": "mm/day"},
            },
        },
        StandardVariable.TEMPERATURE_MIN: {
            "default_source": "pisco",
            "sources": {
                "pisco": {"specific_name": "airtemp_c_min", "unit": "degC"},
            },
        },
        StandardVariable.TEMPERATURE_MEAN: {
            "default_source": "pisco",
            "sources": {
                "pisco": {"specific_name": "airtemp_c_mean", "unit": "degC"},
            },
        },
        StandardVariable.TEMPERATURE_MAX: {
            "default_source": "pisco",
            "sources": {
                "pisco": {"specific_name": "airtemp_c_max", "unit": "degC"},
            },
        },
        StandardVariable.SOLAR_RADIATION: {
            "default_source": "era5_land",
            "sources": {
                "era5_land": {"specific_name": "srad", "unit": "MJ/m^2/day"},
            },
        },
        StandardVariable.VAPOR_PRESSURE: {
            "default_source": "era5_land",
            "sources": {
                "era5_land": {"specific_name": "vp_hpa", "unit": "hPa"},
            },
        },
    }

default_t_range property

__init__(uri, region=None, download=False)

Source code in hydrodataset/camels_pe.py
28
29
30
31
32
33
34
35
def __init__(
    self, uri: str, region: Optional[str] = None, download: bool = False
) -> None:
    super().__init__(uri)
    self.region = region
    self.download = download
    if not str(uri).startswith("s3://"):
        self.aqua_fetch = CAMELS_PE(uri)

read_object_ids()

Read station IDs.

Local: delegate to the aqua_fetch wrapper's stations(). Cloud (S3): read stations.csv from the metadata dir directly (no aqua_fetch).

Source code in hydrodataset/camels_pe.py
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def read_object_ids(self) -> np.ndarray:
    """Read station IDs.

    Local: delegate to the aqua_fetch wrapper's ``stations()``. Cloud (S3):
    read ``stations.csv`` from the metadata dir directly (no aqua_fetch).
    """
    if not self._is_cloud():
        if hasattr(self, "aqua_fetch"):
            return np.sort(np.array(self.aqua_fetch.stations()))
        raise NotImplementedError
    fs = self._make_s3fs()
    rel = "CAMELS_PE/CAMELS-PE_v1.0.1/CAMELS-PE/01_metadata/stations.csv"
    uri = str(self.data_source_dir).rstrip("/")
    with fs.open(f"{uri}/{rel}".removeprefix("s3://")) as fh:
        stations = pd.read_csv(fh, dtype={"gauge_id": str})
    return np.sort(stations["gauge_id"].astype(str).to_numpy())

read_constant_cols(object_ids=None, constant_cols=None, gage_id_lst=None, var_lst=None, **kwargs)

Source code in hydrodataset/camels_pe.py
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
def read_constant_cols(
    self,
    object_ids=None,
    constant_cols=None,
    gage_id_lst=None,
    var_lst=None,
    **kwargs,
) -> np.ndarray:
    if object_ids is None:
        object_ids = gage_id_lst
    if constant_cols is None:
        constant_cols = var_lst
    ds = self.read_attr_xrdataset(
        gage_id_lst=object_ids,
        var_lst=constant_cols,
        **kwargs,
    )
    return ds.to_array().transpose("basin", "variable").values

read_relevant_cols(object_ids=None, t_range_list=None, relevant_cols=None, gage_id_lst=None, t_range=None, var_lst=None, forcing_type=None, **kwargs)

Source code in hydrodataset/camels_pe.py
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
def read_relevant_cols(
    self,
    object_ids=None,
    t_range_list=None,
    relevant_cols=None,
    gage_id_lst=None,
    t_range=None,
    var_lst=None,
    forcing_type=None,
    **kwargs,
) -> np.ndarray:
    if object_ids is None:
        object_ids = gage_id_lst
    if t_range_list is None:
        t_range_list = t_range
    if relevant_cols is None:
        relevant_cols = var_lst
    ds = self.read_ts_xrdataset(
        gage_id_lst=object_ids,
        t_range=t_range_list,
        var_lst=relevant_cols,
        **kwargs,
    )
    return ds.to_array().transpose("basin", "time", "variable").values

read_target_cols(object_ids=None, t_range_list=None, target_cols=None, gage_id_lst=None, t_range=None, **kwargs)

Source code in hydrodataset/camels_pe.py
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
def read_target_cols(
    self,
    object_ids=None,
    t_range_list=None,
    target_cols=None,
    gage_id_lst=None,
    t_range=None,
    **kwargs,
) -> np.ndarray:
    if object_ids is None:
        object_ids = gage_id_lst
    if t_range_list is None:
        t_range_list = t_range
    if target_cols is None:
        target_cols = ["streamflow"]
    ds = self.read_ts_xrdataset(
        gage_id_lst=object_ids,
        t_range=t_range_list,
        var_lst=target_cols,
        **kwargs,
    )
    return ds.to_array().transpose("basin", "time", "variable").values