gcamreader

gcamreader provides functions for reading data from the output databases produced by GCAM, returning results as pandas DataFrames.

From GCAM XML output databases to analysis-ready pandas DataFrames in four steps: locate the data, connect, run queries (filtering by scenario and region), and analyze.

Contents

• Installation
  • Requirements
  • Verify your Java installation
  • Set up a virtual environment
  • Install from PyPI
  • Upgrade to the latest version
  • Install from source
  • Troubleshooting
• Usage
  • Query a local database
  • Run many queries at once
  • Query a remote database
  • Filtering scenarios and regions
• Command line interface
  • Version
  • Local database queries
  • Remote database queries
• Verified GCAM Versions
  • Test environment
  • Compatibility matrix
  • Performance figures
  • Query output across versions
    • Why the counts change
  • Reproducing these results
• API reference
  • Query
    • Query.querystr
    • Query.regions
    • Query.title
  • parse_batch_query()
  • sample_data_dir()
  • LocalDBConn
    • LocalDBConn.dbpath
    • LocalDBConn.dbfile
    • LocalDBConn.suppress_gabble
    • LocalDBConn.maxMemory
    • LocalDBConn.miclasspath
    • LocalDBConn.runQuery()
    • LocalDBConn.listScenariosInDB()
  • RemoteDBConn
    • RemoteDBConn.dbfile
    • RemoteDBConn.username
    • RemoteDBConn.password
    • RemoteDBConn.address
    • RemoteDBConn.port
    • RemoteDBConn.runQuery()
    • RemoteDBConn.listScenariosInDB()
  • importdata()
• Contributing
  • Building the documentation
  • Regression baseline
• Changelog
  • Unreleased
  • 1.5.0 — 2026-06-15
    • Added
    • Changed
    • Fixed
    • Removed
    • Release verification