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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.32-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.32.tar.gz
Algorithm Hash digest
SHA256 ac690f700f5b23c809e6440333d77e0e0b03efaf7da80dd462d2cc1ab3e8b4c1
MD5 79914fd046b051e68925e845a2dba25f
BLAKE2b-256 59f58d2d869295c078a88c4d7abc36a3d5b981cf0e87e7912e439fbd8b0b78b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.32-py3-none-any.whl
Algorithm Hash digest
SHA256 c20f91fc1141539582521e3e76786ed9f4c64be22b70f0396084b74befdc5387
MD5 0e8151408fd0b9ec2650e285ceb024cf
BLAKE2b-256 49812cc84794b73c94ba99fdbd22728acef4c858406ccb593e9e9ef1465ba9a5

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