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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.19.tar.gz
Algorithm Hash digest
SHA256 89675b4ee5c3296b1e46d864128dd2394dbb45542ce91bff1f1cd9849d29f888
MD5 72a8be0aa18af77bd0fa21590db27761
BLAKE2b-256 a09d31d067c0ed66c955ab437d60ad1416d7051ecc064061aba24f03821f9df2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 0256e754aaf8584427ee6a21c7021da375c4d02332e50998035552e9c03ab911
MD5 6a894aacb6c4296a744c433d37d1a89a
BLAKE2b-256 a9856c357e418d8535b17d0580939e9e282ee172e790d20abf6e466413887ef4

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