Skip to content

Open Climate Risk (Beta)

Open Climate Risk (OCR) is CarbonPlan's platform, currently in beta, for analyzing and visualizing climate-related risks at a building-level resolution across the Continental United States (CONUS). While in beta, you may notice broken links to code references (GitHub project is currently private).

Getting Started

If you want to access and analyze OCR's fire risk data:

  1. Start with Working with Data to learn how to load production datasets
  2. Explore the Data Schema to understand available variables
  3. Check [Data Downloads][data-downloads] for an overview of all available formats

If you want to develop or contribute to OCR:

  1. Follow the Installation guide to set up your development environment
  2. Read the Project Structure to understand the codebase
  3. Review Snapshot Testing for testing practices

If you want to understand how fire risk is calculated:

  1. Read the Fire Risk Overview for conceptual background
  2. Explore Data Sources and Provenance

Documentation Structure

This documentation follows the Diataxis framework to help you quickly find what you need:

  • Tutorials

    Learning-oriented guides that walk you through complete workflows step-by-step.

    Browse tutorials

  • How-to Guides

    Task-oriented instructions to accomplish specific goals, organized by user type.

    User guides Developer guides

  • Methods

    Conceptual explanations of our scientific approaches and implementation decisions.

    Fire risk methods

  • Reference

    Technical specifications, API documentation, and configuration details.

    API reference Deployment

Support

License

OCR code is released under the MIT License. See LICENSE for details. See data downloads for information about data licensing.