Documenting the Cal-Adapt API

View Website
Services
  • Web Development
  • Documentation
Client
  • California Energy Commission
  • Strategic Growth Council
Date
September 2013 - February 2018

Background

Cal-Adapt provides peer-reviewed climate data and climate tools for California. The Cal-Adapt API provides programmatic access to climate data hosted on Cal-Adapt. It is built using Django, Django REST framework, and Django-Spillway, an open source library developed at the GIF.

My Work

I set up the documentation stack for the Cal-Adapt API using Sphinx, a popular documentation generator for Python projects, using a theme from Read the Docs. I wrote tutorials and code samples to help users interested in working with the Cal-Adapt API.

Credits

Co-developed with the team at the Geospatial Innovation Facility, UC Berkeley.

Screenshot of the Get Started section for Caladapt API documentationScreenshot of list of jupyter notebooks for using Caladapt API