Transforms Reference
Transforms are optional post-parse system modifiers exposed under the r2x.transforms entry point group.
Follow prepare a PCM handoff for a complete modifier inventory, input requirements, ordering choices, cost-unit checks and CLI pipeline profiles.
Available Transforms
Section titled “Available Transforms”add-pcm-defaultsadd-emission-capadd-electrolyzer-loadadd-purchaser-loadadd-ccs-creditbreak-gensadd-importsadd-optimal-siting
Configuration Summary
Section titled “Configuration Summary”Each transform accepts a plugin-specific configuration model. Use the CLI guide to add a modifier step. Import configuration classes and functions from the modules linked below. Source definitions give each field type, default and required input.
| Transform | Configuration model | Main purpose |
|---|---|---|
break-gens | BreakGensConfig | Split oversized generators into reference units |
add-pcm-defaults | PCMDefaultsConfig | Fill or override generator attributes |
add-emission-cap | EmissionCapConfig | Add an annual CO2 constraint |
add-electrolyzer-load | ElectrolyzerConfig | Add legacy electrolyzer and hydrogen-price data |
add-purchaser-load | PurchaserLoadConfig | Add hydrogen-production and data-center demand |
add-ccs-credit | CCSCreditConfig | Apply CCS incentives |
add-imports | ImportsConfig | Add Canadian import time series |
add-optimal-siting | OptimalSitingConfig | Apply loadsite increments to demand profiles |
Purchaser Load Transform
Section titled “Purchaser Load Transform”Transform id: add-purchaser-load
Module: r2x_reeds.sysmod.purchaser_load
Function: add_purchaser_load(system, config)
Purpose:
- Adds/updates electrolyzer, steam methane reforming and data center purchaser-load components
- Attaches hourly load profiles for those components
Important behavior:
- If the demand component for one of the ReEDS electricity-consuming technologies handled here (
electrolyzer,smrorsmr_ccs) already exists, capacity-based creation of that component is skipped to avoid double counting.
Config model: PurchaserLoadConfig
Main fields:
solve_yearweather_yearhour_map_myr_fpathhydrogen_production_capacity_fpathconsume_characteristics_fpathhydrogen_production_load_fpathhydrogen_production_annual_load_fpathloadsite_op_fpath
Legacy Electrolyzer Transform
Section titled “Legacy Electrolyzer Transform”Transform id: add-electrolyzer-load
Module: r2x_reeds.sysmod.electrolyzer
Purpose:
- Legacy workflow for adding electrolyzer load and hydrogen fuel price time series
Other Transforms
Section titled “Other Transforms”add-pcm-defaults: apply PCM default attributes to generatorsadd-emission-cap: add annual emissions constraints and optional precombustion adjustmentsadd-ccs-credit: apply CCS credit economicsbreak-gens: split generators into reference units (optionally filtered by region, generator name, or technology)add-imports: attach daily Canadian import energy budgetsadd-optimal-siting: add loadsite increments to existing load profiles
break-gens config highlights
Section titled “break-gens config highlights”The BreakGensConfig model supports targeted disaggregation workflows without changing default behavior:
include_regions: only split generators in these balancing areasinclude_generators: only split generators with these namesinclude_technologies: only split generators with these technologies
When more than one include filter is provided, matching uses OR behavior.
A generator is split if it matches any one of include_regions, include_generators, or include_technologies.
If these fields are omitted, break-gens keeps the original workflow and considers all eligible generators.
Configuration fields and source
Section titled “Configuration fields and source”BreakGensConfig
Section titled “BreakGensConfig”Module: r2x_reeds.sysmod.break_gens.
Package fields: reference_units, drop_capacity_threshold, skip_categories, break_category, include_regions, include_generators, include_technologies.
PCMDefaultsConfig
Section titled “PCMDefaultsConfig”Module: r2x_reeds.sysmod.pcm_defaults.
Package fields: pcm_defaults_fpath, pcm_defaults_dict, pcm_defaults_override.
EmissionCapConfig
Section titled “EmissionCapConfig”Module: r2x_reeds.sysmod.emission_cap.
Package fields: emission_cap, switches_fpath, emission_rates_fpath, co2_cap_fpath, default_unit.
ElectrolyzerConfig
Section titled “ElectrolyzerConfig”Module: r2x_reeds.sysmod.electrolyzer.
Package fields: weather_year, electrolyzer_load_fpath, h2_fuel_price_fpath, hour_map_fpath.
PurchaserLoadConfig
Section titled “PurchaserLoadConfig”Module: r2x_reeds.sysmod.purchaser_load.
Package fields: solve_year, weather_year, hydrogen_production_capacity_fpath, consume_characteristics_fpath, hydrogen_production_load_fpath, hydrogen_production_annual_load_fpath, loadsite_op_fpath, hour_map_myr_fpath.
CCSCreditConfig
Section titled “CCSCreditConfig”Module: r2x_reeds.sysmod.ccs_credit.
Package fields: co2_incentive_fpath, emission_capture_rate_fpath, upgrade_link_fpath.
ImportsConfig
Section titled “ImportsConfig”Module: r2x_reeds.sysmod.imports.
Package fields: weather_year, solve_year, canada_imports_fpath, canada_szn_frac_fpath, hour_map_fpath.
OptimalSitingConfig
Section titled “OptimalSitingConfig”Module: r2x_reeds.sysmod.optimal_siting.
Package fields: loadsite_op_fpath, hour_map_myr_fpath, solve_year.