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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.27-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.27.tar.gz
Algorithm Hash digest
SHA256 958345c1cd3cf1266ae4a7218730d374722e65ace32ee3d4ffe9b5eab1da7aa3
MD5 2f0de49a86c3d9385c5f6157968c0956
BLAKE2b-256 5598ecca1152c81e222c52f94f85bcd9dd873027dfd6ba9e9c238f055372c9fb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 dfd78a547ec81784a3c90a8c23b986161151bb10d99cb7275a16a3f16abd54f0
MD5 ad0137d19efb1ef9fab6916e7c3fedd8
BLAKE2b-256 ffded540071c29d995fa7f6728fe56840a3d6a3722bdd90670c8976ade58d703

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