DHIS2 Climate API

DHIS2 Climate API extracts, transforms, and loads climate and Earth Observation data into DHIS2 and the CHAP modelling platform.

Status: active development. Current focus is on dataset ingestion, sync workflows, and GeoZarr storage. APIs and data models may change without notice.

Setup

Using uv (recommended)

Install dependencies (requires uv):

uv sync

Copy .env.example to .env and adjust values as needed. Environment variables are loaded automatically from .env at runtime.

Key environment variables:

• DHIS2_BASE_URL — DHIS2 API base URL (defaults to play server in .env.example)
• DHIS2_USERNAME — DHIS2 username
• DHIS2_PASSWORD — DHIS2 password

Start the app:

uv run uvicorn climate_api.main:app --reload

Using pip

If you cannot use uv (e.g. mixed conda/forge environments):

python -m venv .venv
source .venv/bin/activate
pip install -e .
uvicorn climate_api.main:app --reload

Using conda

conda create -n dhis2-climate-api python=3.13
conda activate dhis2-climate-api
pip install -e .
uvicorn climate_api.main:app --reload

Development

Common Makefile targets:

Target	Description
make sync	Install dependencies with uv
make run	Start the app with uvicorn (hot reload)
make lint	Check linting, formatting, and types
make fix	Autofix ruff lint and format issues
make test	Run the test suite with pytest
make openapi	Regenerate the pygeoapi OpenAPI spec
make start	Build and start the Docker stack
make restart	Tear down, rebuild, and restart the Docker stack

Endpoints

Once running, the API is available at:

Endpoint	Description
http://localhost:8000/	Welcome / health check
http://localhost:8000/docs	Interactive API documentation (Swagger UI)
http://localhost:8000/ogcapi	OGC API root
http://localhost:8000/zarr/{dataset_id}	GeoZarr store for a published dataset

pygeoapi

The OGC API is served by pygeoapi, mounted at /ogcapi. Its configuration is generated dynamically from published artifacts and written to data/pygeoapi/pygeoapi-config.yml.

To validate the configuration manually:

PYTHONPATH="$(pwd)/src" uv run pygeoapi config validate -c data/pygeoapi/pygeoapi-config.yml

Regenerate after changes to config/pygeoapi/base.yml or publication logic:

make openapi