API Reference
Public API
Stable entry points for running the pipeline and listing targets.
| list_targets | List all available Hamilton targets. |
| run | Execute specific Hamilton targets. |
| run_all | Execute end-to-end pipeline with all targets and generate DAG visualizations. |
| visualize_graph | Render Hamilton DAG to image file. |
Hamilton Nodes (core)
Hamilton DAG nodes that define the public analysis and visualization surface.
| nodes.gold_emissions | Gold Layer Emissions Hamilton Nodes |
| nodes.gold_api_views | Gold Layer API Views Hamilton Nodes |
| nodes.gold_decision | Gold Layer - Decision Support Hamilton Nodes |
| nodes.gold_ranking | Gold Layer Ranking Hamilton Nodes |
| nodes.analysis_core | Analysis Hamilton Nodes |
| nodes.viz_working | Working Visualizations - Using Real Gold Data |
| nodes.viz_decision | Decision Support Visualizations |
Decision & Ranking Logic
Business logic used to compute scores, rankings, and opportunities.
| layers.gold.decision_metrics | Decision-useful metrics for investment, operations, and compliance. |
| layers.gold.rankings | Gold Layer Rankings - Company Rankings |
| layers.gold.emissions | Gold Layer Emissions - Petrinex Emissions Calculations |
Configuration & Schema
Project configuration and Parquet table schemas.
| config | Centralized configuration for data paths and constants. |
| schemas | Schema definitions for 7 Parquet tables in data warehouse. |
Utilities
Reusable conversion and IO helpers.
| utils.conversions | Convert production volumes to barrels of oil equivalent (BOE). |
| utils.io_utils | IO Utils - ParquetWriter and Convenience Wrappers |
| logging_config | Structured logging configuration for the emissions pipeline. |
Infrastructure
Parquet writer and storage utilities.
| infrastructure.parquet_writer | Write DataFrames to partitioned Parquet files following Gold schema. |