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


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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.46-py3-none-any.whl (48.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.46.tar.gz
Algorithm Hash digest
SHA256 c75c7c6bf54487aee2734eca10b9dd9ac6922ab27294c48acaaf1bfcfacf15f1
MD5 ab00ca403266cf6446f5079c0ea3747d
BLAKE2b-256 c9280a1456b73af8b00a32c73887286ccfdff3b38a3e8b7370248722da829bd6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.46-py3-none-any.whl
Algorithm Hash digest
SHA256 ea33cfc284e30576a135a82b8e7c11ffea3c9f4a236ae579782c7db7c20fc9b3
MD5 b83ed832a57141a924607fe7fbd3478b
BLAKE2b-256 2666097e1a5a148fbaaea4960ced22421d4d1a5675cb5881ec97d8c2f4d71099

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