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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.33.tar.gz
Algorithm Hash digest
SHA256 1d447db9264d45a548cfbf034de24cf42318c4d6966ffa2774a6f215fd3241d3
MD5 a5db27a7ace5cc8a4f3cb0f9bdba2133
BLAKE2b-256 4080ec2f28822963a47fd92edd569c0d2338e0e97dbe7250a9871f2035e15fcb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.33-py3-none-any.whl
Algorithm Hash digest
SHA256 1aa4a68ea2d8aec04c4be80b3d2c78e396d96e5a928c4b9e4d0c26f49d1819de
MD5 0339425b906412574de984da89fb258d
BLAKE2b-256 67a4f0ffa17c114c3e1f8a129e3b69260348296e62d6efdea76589de69c88739

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