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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.24.tar.gz
Algorithm Hash digest
SHA256 40d3e1800cbf52a71832b39cfc3add733966d6c3c5a0024be7e01d30799e7d71
MD5 500fcd6c8633f39c03e3b2a25d8715c9
BLAKE2b-256 36d44a7bdf93fa6db83f3e3c102b33e0cbea86892a7a70274bf88ed02c172aaf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.24-py3-none-any.whl
Algorithm Hash digest
SHA256 af71c6e68a3652eb84ab1a8b545665dc3da4284876564c80627f3c501bd94379
MD5 7fe2ffd5acd9d2c8da427ec9f7bf3c8e
BLAKE2b-256 486d89283c32cceb6bad9f42261e2d8b9db5a517e3d502e31dfb1953235da312

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