Metadata-Version: 2.4
Name: camelsafr
Version: 0.1.2
Summary: Python client for the CAMELS-Afr African basin hydrological database
Project-URL: Homepage, https://github.com/cgiar-hydrology/camelsafr
Project-URL: Documentation, https://camelsafr.readthedocs.io
License: MIT
Keywords: Africa,CAMELS,basins,hydrology,water
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: >=3.9
Requires-Dist: pandas>=2.0
Requires-Dist: pyarrow>=14
Provides-Extra: dev
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest>=7; extra == 'dev'
Provides-Extra: xarray
Requires-Dist: xarray>=2023.1; extra == 'xarray'
Description-Content-Type: text/markdown

# camelsafr

[![PyPI](https://img.shields.io/pypi/v/camelsafr)](https://pypi.org/project/camelsafr/)
[![Docs](https://readthedocs.org/projects/camelsafr/badge/?version=latest)](https://camelsafr.readthedocs.io)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

Python client for the **CAMELS-Afr** African basin hydrological database —
216 static attributes and 44 years of daily/monthly/annual timeseries for
15,937 basins across four spatial levels.

## Install

```bash
pip install camelsafr
# with xarray support:
pip install camelsafr[xarray]
```

## Quickstart

```python
import camelsafr as ca

ca.info()                              # print dataset summary
df = ca.attrs(level='L1')             # 37 basins × 216 attributes
ts = ca.timeseries(level='L1',
                   basin_ids=['L1_001'],
                   freq='annual')      # annual climate for one basin
```

## Documentation

Full docs at [camelsafr.readthedocs.io](https://camelsafr.readthedocs.io).

## Data

Data hosted on AWS CloudFront. No API key required.
Source: CGIAR Hydrology / IWMI. Citation: _[paper pending]_.
