OpenClimate Python Client Documentation

OpenClimate is a datastore for emissions data and target pledges. The OpenClimate Python Client is a Python 3.8+ package that provides a high-level interface to the OpenClimate API.

The goal of this package is to make it easier to focus on the analysis by abstracting away the details of making HTTP requests and handling responses.

Note

This is a work in progress. We strongly encourage you to open issues and contribute code.

Installation

# for latest release
pip install openclimate

# for bleeding-edge up-to-date commit
pip install -e git+https://github.com/Open-Earth-Foundation/OpenClimate-pyclient.git

Contents:

• Quickstart Guide
  • Installation
  • Emissions
  • Targets
  • Population
  • GDP
  • Searching for codes
• Autogenerated API

Analyses:

• Emissions and Emissions per capita
  • Emissions
  • Emissions per capita
• Cumulative emissions
  • Get country codes
  • Which datasets are available?
  • Get emissions
  • Get emissions for all countries
  • Calculate cumulative emissions
  • Rank country by cumulative emissions
  • Plot cumulative emissions
• Great Britain emissions
  • Get data
  • Is Great Britain on track?
  • Plot of emissions and pledges
• Canada Emissions Breakdown
• Canada Target Gap
  • Get country emissions and targets
  • Get province emissions and targets
  • Calculate target gap
  • Create figure

Help and Reference

• Contribution Guide
  • Feature requests and feedback
  • Report bugs
  • Fix bugs
  • Preparing Pull Requests
• Code Contributors
• GitHub Repo

Indices and tables

• Index

• Module Index

• Search Page