Reference Documentation¶
Technical reference for PowerGenome parameters, data schemas, and command-line interface.
Settings Parameters¶
Comprehensive documentation of all settings parameters organized by functional area:
- Model Definition: Planning periods, target year, timezone
- Regions and Geography: Model regions, aggregations, capacity reserves
- Existing Generators: Clustering, retirements, hydro configuration
- New Build Resources: Technology costs, WACC, regional availability
- Fuels: Fuel prices, emission factors, CCS configuration
- Demand and Load: Load profiles, growth rates, distributed generation
- Transmission: Network constraints, expansion costs, line loss
- Time Reduction: Representative period selection and weighting
- Resource Tags: Technology categorization for model behavior
- Multi-Scenario Management: Parameter variation across cases
Data Schemas¶
Documentation of input and output file formats:
- Input Tables: Required columns and data types for source data
- Output Files: GenX CSV file formats and specifications
Command-Line Interface¶
- CLI Reference: All command-line flags and options
Additional Resources¶
- System Design Tool: Interactive tool for generating settings files for your study area
- System Design Tool Documentation: Walkthrough of each configuration step
- Test System: Minimal test configuration
API Reference¶
API Documentation Pending
Comprehensive Python API documentation will be added once module docstrings are enhanced. In the meantime, refer to the source code on GitHub.
Using This Reference¶
- Finding Parameters: Use the search function (top of page) or browse by category
- Data Types: All parameters show expected data type (string, list, dict, etc.)
- Examples: Most parameters include YAML examples
- Required vs Optional: Required parameters are clearly marked
- Defaults: Default values are shown when applicable