README.md

carbonplan / offsets-db-data

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

installation

To install the package, you can use pip:

python -m pip install git+https://github.com/carbonplan/offsets-db-data.git

You can also install the package locally by cloning the repository and running:

git clone https://github.com/carbonplan/offsets-db-data.git
cd offsets-db-data
python -m pip install -e .

To install the dependencies for development, you can use pip:

python -m pip install -e ".[all]"

# or

python -m pip install -e ".[dev]"

building the documentation

To build the documentation locally, you can use sphinx. You can install the documentation dependencies by running:

python -m pip install -e ".[docs]"

Then, you can build the documentation by running:

sphinx-build docs docs/_build

You can view the documentation by opening docs/_build/index.html in your browser.

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.