carbonplan / offsets-db-data

Utilities for cleaning, and processing data for the OffsetsDB web tool

installation

This project uses Pixi for environment and dependency management.

1. Install Pixi: follow the installation instructions

2. Clone and set up:

git clone https://github.com/carbonplan/offsets-db-data.git
cd offsets-db-data
pixi install

Common tasks:

pixi run test              # Run unit tests
pixi run test-cov          # Run unit tests with coverage
pixi run test-integration  # Run integration tests (requires S3 + OpenRefine)
pixi run test-all          # Run unit + integration tests
pixi run lint              # Run linting
pixi run format            # Format code
pixi run format-check      # Check formatting without modifying files
pixi run docs-build        # Build documentation

Activate an interactive shell with all dependencies:

pixi shell

pip (alternative)

python -m pip install offsets-db-data
# or editable install with dev deps:
python -m pip install -e ".[dev]"

building the documentation

pixi run docs-build

Open docs/_build/index.html in your browser to view the result.

license

All the code in this repository is MIT licensed.

Important

Data associated with this repository are subject to additional terms of data access.

about us

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