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

Uploaded Source

Built Distribution

carbon_registry_indexer-0.1.51-py3-none-any.whl (48.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for carbon-registry-indexer-0.1.51.tar.gz
Algorithm Hash digest
SHA256 2f5c3689f1f4c132faf7bf15b77620b6701e6852469fc18234ef8cc3836c2b71
MD5 6af5eea2039644b3a19206df31115e27
BLAKE2b-256 0c200d4ad954932d7a2365b32b75884f2a18eaff3a9636c86811448f35a8f53a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for carbon_registry_indexer-0.1.51-py3-none-any.whl
Algorithm Hash digest
SHA256 d02bd7cccbcae5826bc46abdbe64835f26b9b5a1e3375a70059436e152591c09
MD5 787042df23390733730ba367d2843f1d
BLAKE2b-256 999162a127f0fe52c7b8a797e787cbced2778b6877d0ea346e5d2cb48c6d5a3f

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