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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.36-py3-none-any.whl (44.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.36.tar.gz
Algorithm Hash digest
SHA256 6f40278ffc4065e07a85d05212a10a989d1b26f2a7579947c1e2a651ed5f91aa
MD5 732d91cb9e907d15600b92bd64916336
BLAKE2b-256 d2f0c43a49e5595ae5b5557cd9ce1e06ffdffdf2b479fdba1f49c31ebf96663f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.36-py3-none-any.whl
Algorithm Hash digest
SHA256 60238a32990ed944df5c3cce81226a391733e2bd6ffd8a89440a1a053ead6124
MD5 5dfd6a745dd92b724847a27cbdbcdffd
BLAKE2b-256 5ef6350a409649c2025e36cc50edca1d0e559537967ad1579ce36515a1a85256

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