Skip to main content

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

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()

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

carbon-registry-indexer-0.1.25.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.25-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

Details for the file carbon-registry-indexer-0.1.25.tar.gz.

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.25.tar.gz
Algorithm Hash digest
SHA256 49cba52c7a85e40f3c586ce7b639ead7f78a1b140d40f31f08df1810d6f3e02f
MD5 3a8430556f4947aa3b1d97b98c933bbc
BLAKE2b-256 3a8b572350aedefc801a8c57dd255bdbfb4878a35c372b8cfba2993a0a9bf584

See more details on using hashes here.

File details

Details for the file carbon_registry_indexer-0.1.25-py3-none-any.whl.

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.25-py3-none-any.whl
Algorithm Hash digest
SHA256 4e7b0e2481850bd368f268eb0ad842ea18f47be79aa0a40e2a5c1c60acff16cc
MD5 f0eb2aafd65572775bf68b4d6c555cdd
BLAKE2b-256 9076825d58597b76aee8566ee9e9eb999045a2824a6dd2f8761d48743f92182a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page