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.26.tar.gz (35.2 kB view details)

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.26-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.26.tar.gz
Algorithm Hash digest
SHA256 331292984dd02f602cb0e3943fb01f4c7dab61fa2839d320ee828adc455817e2
MD5 0894a3621049295a00de953bb7092f18
BLAKE2b-256 8d39af27255893729d8112cbe2b37d305117955b1693290d3b470adb2e9da20e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.26-py3-none-any.whl
Algorithm Hash digest
SHA256 f48f21ea2df5762d1953f5c9bfe69794ef8a8e2238ee1b65e3dabc3e4639c75b
MD5 387a6a4ec298fad6a3c5af62b7f2c49f
BLAKE2b-256 d0a09d927cdc297e4f0f89b894e2be74ee5abbbfbb13eafc150d31a295458e57

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