Climakitae Documentation

Note

This project is actively in development, so the functionality documented here may evolve over time. We strive to keep our documentation up to date and appreciate your patience as we continue improving and streamlining the codebase.

Climakitae provides a python toolkit for retrieving and performing scientific analyses with climate data from the Cal-Adapt Analytics Engine.

Getting Started

An introductory notebook demonstrating how to get started with climakitae and the Cal-Adapt Analytics Engine.

API Reference

A detailed description of the climakitae API.

GitHub

Interested in seeing the source code? Check out the repository on GitHub!

Contribution Guidelines

Want to add a new feature? Find a bug in the code? See our contribution guidelines for more information.

About the Cal-Adapt Analytics Engine

Cal-Adapt is the larger project through which climakitae is being developed. For more information, check out our Analytics Engine website.

Installation

To begin working with climakitae, you can install the current version of the package directly from pip:

pip install https://github.com/cal-adapt/climakitae/archive/main.zip