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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.29.tar.gz
Algorithm Hash digest
SHA256 3610ab254d2ccf68a00758c5be71061f68587b371c2c898beab2d33c09305e8b
MD5 6ec9733492e83de864ccb7a8601bb169
BLAKE2b-256 95d090ebdca53fb8fea9f020b2e9bec34c480f25d22b58adf706d2d3fb43ab60

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.29-py3-none-any.whl
Algorithm Hash digest
SHA256 6f5c8edc9a8564314f73338bba9d0b665b4bba32dca6f1b3f1f58c882ef06fc6
MD5 b42661cd2d5576171d0e7d92e3324905
BLAKE2b-256 077d332d63fd00ddc951a46c70248e9097df45e1649dd93beb86d80aa892a38f

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