Climakitae

A powerful Python toolkit for climate data analysis and retrieval from the Cal-Adapt Analytics Engine (AE).

Climakitae provides intuitive tools for accessing, analyzing, and visualizing downscaled CMIP6 data, enabling researchers and practitioners to perform comprehensive climate impact assessments for California.

[!WARNING] This package is under active development. APIs may change between versions.

Key Features

• 🌡️ Comprehensive Climate Data Access: Retrieve climate variables from hosted climate model, weather station, and renewable energy datasets
• 📊 Downscaled Climate Models: Access dynamical (WRF) and statistical (LOCA2) downscaling methods
• 🗺️ Spatial Analysis Tools: Built-in support for geographic subsetting and spatial aggregation
• 📈 Climate Indices: Calculate heat indices, warming levels, and extreme event metrics
• 🔧 Flexible Data Export: Export to NetCDF, CSV, and Zarr

About Cal-Adapt

Climakitae is developed as part of the Cal-Adapt Analytics Engine, a platform for California climate data and tools. Cal-Adapt provides access to cutting-edge climate science to support adaptation planning and decision-making.

Getting Started

Installation

Climakitae requires Python 3.12 or 3.13. We recommend uv on Linux/macOS and conda on Windows or when native geospatial dependencies cause trouble.

Quick install of the latest release:

# with uv
uv pip install climakitae

# with conda
conda create -n climakitae python=3.13 -y
conda activate climakitae
pip install climakitae

For editable installs, developer dependencies, and platform-specific tips, see the Installation Guide on the wiki.

Basic Usage

from climakitae.new_core.user_interface import ClimateData

# Retrieve monthly max temperature for Los Angeles in 2015
data = (
    ClimateData()
    .catalog("cadcat")
    .activity_id("WRF")
    .institution_id("UCLA")
    .table_id("mon")
    .grid_label("d03")
    .variable("t2max")
    .processes({
        "time_slice": ("2015-01-01", "2015-12-31"),
        "clip": "Los Angeles",
    })
    .get()
)

# Data is returned as a lazy xarray Dataset
print(data)

The legacy climakitae.core.data_interface.get_data API is still supported for backward compatibility, but new work should use ClimateData from climakitae.new_core.

Documentation

Contributing

We welcome contributions! Please see our contributing guidelines for details on:

• 🐛 Reporting bugs
• 💡 Requesting features
• 🔧 Submitting code changes
• 📖 Improving documentation

For setting up a development environment (editable install, tests, formatters), see the Installation Guide on the wiki.

When opening a pull request, please tag at least two project maintainers for review.

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

Related Projects

• climakitaegui - Interactive GUI tools for climakitae
• cae-notebooks - Example notebooks and tutorials

Support

• 📧 Email: analytics@cal-adapt.org
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions

Contributors