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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.56-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file carbon_registry_indexer-0.1.56.tar.gz.

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.56.tar.gz
Algorithm Hash digest
SHA256 5794988f12d33095501633e30795452b4c640e837c07b09243f2b7fd909d4257
MD5 53279c6ad9bce05f3f1e8b997201b6ed
BLAKE2b-256 8946728e5657dde40128f1ba9e40b7d7a542915ece8a377f0bba8447a80b6d95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.56-py3-none-any.whl
Algorithm Hash digest
SHA256 cf26639e566a4e710433e3d4d5c12a5837fa608f6334a7033a44c69923aed9f9
MD5 ac8848e810cffe932bca2119c4b07f6e
BLAKE2b-256 fbd990fcd941b3cb0910413549a962d5370ace2cdc938fb9fb354ad9c109583d

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