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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.57-py3-none-any.whl (48.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.57.tar.gz
Algorithm Hash digest
SHA256 c5cb597ac75737cb54c8dd22eb39bcb7c09bbc8234912e73155a6f5aa4b761b5
MD5 aa683087a75e9cd453f04d9e1f66f1e7
BLAKE2b-256 66f548d44140940b9d6f015c821b7d4b14158ab6c730516dcc84cea451b28e0a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.57-py3-none-any.whl
Algorithm Hash digest
SHA256 4b02233e477b27e73ce34b52ee9979a245c12fa6fadb45769f847e9f52dfb08a
MD5 3e48f7933d8ec54f4140abbc48484839
BLAKE2b-256 0f2bcdde519bbed1217438f576c07d72821f53016e1dbe1173eca95b138e5797

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