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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.37-py3-none-any.whl (48.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.37.tar.gz
Algorithm Hash digest
SHA256 d7da5233f4886096b96b1cadaa00ab64a610fac3cde32e3a1003614c0e3fc016
MD5 8bc4f29b18536681459eea0d29e9feb9
BLAKE2b-256 04e4e7f63bc0f24d5e2200d9a5e39e0c02d317cb174b301c6f7d1eeb192e01d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.37-py3-none-any.whl
Algorithm Hash digest
SHA256 b8f545ec476fd7becca58fe725f02206e3beded9a16c01dce736bb67050b0f49
MD5 58ea47e8b0dfb97f6872a2893450d274
BLAKE2b-256 3af2f2ca42588d3e93aa65cfe5b9f1e3c9d0a75d6bc64e4b0d1bf1f99b3907f6

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