carbonplan / data

data catalog and curation

This repository includes our main data catalog as well as our pre-processing utilities.

install

python -m pip install carbonplan[data]

usage

The CarbonPlan data archives are currently mirrored on Google Cloud Storage (US-Central) and Microsoft Azure (US-West). Set the CARBONPLAN_DATA environment variable before using the Intake catalog below:

# google (us-central)
export CARBONPLAN_DATA="https://storage.googleapis.com/carbonplan-data"
# or
# azure (us-west)
export CARBONPLAN_DATA="https://carbonplan.blob.core.windows.net/carbonplan-data"

# open the top level catalog
from carbonplan.data import cat

# extract an entry as a Dask-backed Xarray Dataset
cat.mtbs["raster"](region="conus", resolution="4000m").to_dask()

developer documentation

To run the unit and integration tests for this API, run:

$ pytest -v

Catalog entries scan be marked as either skip or xfail by setting the ci key in the metadata dictionary:

foo:
  description: "skip this entry in the CI tests"
  metadata:
    ci: skip

license

All the code in this repository is MIT-licensed. When possible, the data is licensed using the CC-BY-4.0 license. We include attribution and additional license information for third party datasets, and we request that you also maintain that attribution if using this data.

about us

CarbonPlan is a nonprofit organization that uses data and science for climate action. We aim to improve the transparency and scientific integrity of climate solutions with open data and tools. Find out more at carbonplan.org or get in touch by opening an issue or sending us an email.