How-To Guides¶
These guides provide step-by-step instructions for specific tasks. Each guide assumes you have completed the Getting Started tutorial.
Configuration¶
- Configure Settings: Organize settings files, use modular YAML, and manage complex configurations
- Use Year-Keyed Settings Values: Resolve parameter values automatically by planning year across settings files
- Configure Renewable Resource Clusters: Set up wind and solar clusters using filters, bins, groups, and agglomerative or k-means clustering
- Configure Capacity Reserve Requirements: Specify technology credit values for capacity reserve constraints
- Run Multi-Scenario Studies: Set up and execute multi-scenario runs with parameter variations
Validation and Debugging¶
- Validate Settings Before Running: Check settings and data for common configuration mistakes before running the pipeline
- Debugging: Diagnose and fix common errors
Customization¶
- Add Custom Technologies: Define user technologies, modify standard resources, and configure cost parameters
- Modify Generator Attributes: Apply custom formulas to existing generator attributes based on plant age, capacity, or other data fields
Quick Reference¶
| Task | Guide | Difficulty |
|---|---|---|
| Split settings into multiple files | Configure Settings | Easy |
| Set parameter values by planning year | Use Year-Keyed Settings Values | Medium |
| Add a new fuel type | Add Technologies | Easy |
| Apply age-based O&M costs | Modify Generator Attributes | Easy |
| Specify capacity reserve credits | Configure Capacity Reserves | Easy |
| Set up renewable resource clusters | Configure Renewable Clusters | Medium |
| Run sensitivity analysis | Run Scenarios | Medium |
| Filter renewable sites by LCOE | Configure Renewable Clusters | Medium |
| Validate settings before a run | Validate Settings | Easy |
Contributing Guides¶
Found a task that's not covered? Consider contributing a how-to guide! See our Contributing page for guidelines.