README.md

carbonplan / cdr-database

reports on carbon removal projects and technologies

resources

• Main website: https://carbonplan.org/
• This site: https://carbonplan.org/research/cdr-database

to build the projects data

To run the script that generates the project data, first install the requirements:

pip install -r requirements.txt

You will also need to unlock the Google Sheets key using git-crypt. Unlocking is simplest using a symmetric secret key securely shared by a team member.

Finally, you may run the command to generate the projects list for all review cycles:

python scripts/build_projects.py strp2020 strp2021q1 strp2021q4 msft2021

to build the site locally

Assuming you already have Node.js installed, you can install the build dependencies with:

npm install .

To start a development version of the site, simply run:

npm run dev

and then visit http://localhost:5000/research/cdr-database in your browser.

license

All the code in this repository is MIT licensed, but we request that you please provide attribution if reusing any of our digital content (graphics, logo, reports, etc.). Some of the data featured here is sourced from content made available under a CC-BY-4.0 license. We include attribution for this content, and we please 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.