BreakGensConfig
Configuration for breaking oversized generators into reference-sized units.
Import
Section titled “Import”>>> from r2x_reeds.sysmod.break_gens import BreakGensConfig>>> assert BreakGensConfig is not NoneBases: PluginConfig. Inherited contracts remain defined by the base classes.
Declared fields
Section titled “Declared fields”These fields are declared on this class. Required/default behavior is shown directly from source. Base-class fields also apply.
reference_units
Section titled “reference_units”reference_units: Path | str | PathLike | dict[str, Any] | None = Field(default=None, description='Reference unit definitions as a path or mapping.')drop_capacity_threshold
Section titled “drop_capacity_threshold”drop_capacity_threshold: int = Field(default=5, ge=0, description='Threshold of capacity in MW to drop of remainder exist.')skip_categories
Section titled “skip_categories”skip_categories: list[str] | None = Field(default=None, description='Generator categories to skip when breaking units.')break_category
Section titled “break_category”break_category: str = Field(default='category', description='Field name used to look up reference units.')include_regions
Section titled “include_regions”include_regions: list[str] | None = Field(default=None, description='Optional region names (balancing areas) to include for generator splitting.')include_generators
Section titled “include_generators”include_generators: list[str] | None = Field(default=None, description='Optional generator names to include for splitting.')include_technologies
Section titled “include_technologies”include_technologies: list[str] | None = Field(default=None, description='Optional technology names to include for splitting.')Continue with the Python API overview and transform contracts.