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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.23-py3-none-any.whl (40.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.23.tar.gz
Algorithm Hash digest
SHA256 bf24d9769f76aa3a67d7e3ee8be9c1c5aac064adfc0b4e5516a5995434d491a8
MD5 991de096a1d0e5aabe781e460ddf894f
BLAKE2b-256 9e3d9ecd67bbd23dd26ea16f0b0844a30130a170c5d79a1435c5bd616fe92b84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 afbaaf009cb1121c080c490e2c7829a864481fedd39912f8299e5dd8896f0133
MD5 bd6b01b2f5e3caa5e323957c7835dc09
BLAKE2b-256 e578d3a6ef2b5607c261295116faade9cfa811e9d15277647b744a0fafb9d63e

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