A Python library designed to streamline the aggregation of carbon data from multiple registries, each with its own data format, into a unified schema in CSV/Parquet formats.
Project description
Carbon Registry Indexer
Welcome to the CarbonMarketsHQ Data Indexer! This tool is designed to consolidate data from multiple carbon market registries into a unified schema, making it easier to analyze and utilize carbon market data. This project is open source and we welcome contributions from the community.
Supported data sources
- Gold Standard
- American Carbon Registry (ACR)
- Climate Action Reserve (CAR)
- Climate Action Data Trust (CADT)
- Puro Earth
Installation
To install the package, you can use pip:
pip install carbon-registry-indexer
license
All the code in this repository is MIT licensed.
Sample Usage
indexer = CarbonRegistryIndexer(storage_dir='your_storage_dir'
azure_blob_conn_str='your_conn_str',
azure_blob_container='your_container_name')
indexer.setup_storage() # creates or purges data folder
# calls to initiate sync
indexer.sync_gold_standard()
indexer.sync_climate_action_data_trust()
indexer.sync_american_carbon_registry()
indexer.sync_climate_action_reserve()
indexer.sync_puro_earth()
Output model
ProjectLocation
: Stores information about the location of a project, including country, state, and geographic identifier.ProjectRating
: Captures project-level ratings from different rating entities.CoBenefit
: Links a project to the UN Sustainable Development Goals (SDGs) it contributes to.Project
: The core table representing a carbon project. It includes meta information about a project.RelatedProject
: Captures relationships between different projects.Issuance
: Represents an issuance of carbon credits from a project.Label
: Defines a label associated with an issuance, specifying the crediting period and validity.Unit
: Represents the life-cycle of credit units Issued, retired, cancelled, etc.Governance
: Stores picklist values used for governance-related fields.Estimation
: Contains estimated credit information for a project.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file carbon-registry-indexer-0.1.57.tar.gz
.
File metadata
- Download URL: carbon-registry-indexer-0.1.57.tar.gz
- Upload date:
- Size: 39.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5cb597ac75737cb54c8dd22eb39bcb7c09bbc8234912e73155a6f5aa4b761b5 |
|
MD5 | aa683087a75e9cd453f04d9e1f66f1e7 |
|
BLAKE2b-256 | 66f548d44140940b9d6f015c821b7d4b14158ab6c730516dcc84cea451b28e0a |
File details
Details for the file carbon_registry_indexer-0.1.57-py3-none-any.whl
.
File metadata
- Download URL: carbon_registry_indexer-0.1.57-py3-none-any.whl
- Upload date:
- Size: 48.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b02233e477b27e73ce34b52ee9979a245c12fa6fadb45769f847e9f52dfb08a |
|
MD5 | 3e48f7933d8ec54f4140abbc48484839 |
|
BLAKE2b-256 | 0f2bcdde519bbed1217438f576c07d72821f53016e1dbe1173eca95b138e5797 |