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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.53-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.53.tar.gz
Algorithm Hash digest
SHA256 47ba1eaf76881c14510ee90b1b0e2bffc8689b4538dbeb97964f147025464bb5
MD5 0422a113d90a8036060e4c678504e4b3
BLAKE2b-256 b26235d1479ae8e3dd7a41cb685f9b0c5fcdb5c75854c67028127441c347bc1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.53-py3-none-any.whl
Algorithm Hash digest
SHA256 4517173e60f67784ee093921be4368b90cf8eb61206e3e639389d1739b542fd0
MD5 0ffa77e7adc695691fbca046a3d46717
BLAKE2b-256 277135327a964a234444bf725f798442f885a9174522e49f53263198b40e8aa5

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