Reference¶
R2X PLEXOS provides parser and exporter plugins for PLEXOS power system models.
Core Classes¶
Parser & Exporter¶
PLEXOSParser- Parse PLEXOS XML filesPLEXOSExporter- Export to PLEXOS XML formatPLEXOSConfig- Configuration model
Component Models¶
Base Classes¶
PLEXOSObject- Base class for all PLEXOS componentsPLEXOSComponent- Component with properties
Generation & Storage¶
PLEXOSGenerator- Generator componentsPLEXOSBattery- Battery storagePLEXOSStorage- Storage components
Network Components¶
PLEXOSNode- Network nodesPLEXOSLine- Transmission linesPLEXOSInterface- Network interfaces
Regions & Zones¶
PLEXOSRegion- Regional componentsPLEXOSZone- Zone componentsPLEXOSReserve- Reserve requirements
Other Components¶
PLEXOSFuel- Fuel typesPLEXOSVariable- Variables and expressionsPLEXOSTimeslice- Time slice definitions
Data Models¶
PLEXOSPropertyValue- Property values (scalar or time series)PLEXOSMembership- Component relationshipsCollectionProperties- Collection-level propertiesPLEXOSDatafile- Data file references
Simulation Models¶
PLEXOSModel- PLEXOS model configurationPLEXOSHorizon- Time horizon configuration
For detailed API documentation with examples and method signatures, see the Complete API Documentation.
Documentation Coverage¶
| Filename | Total | Covered | Missing | Coverage in % |
|---|---|---|---|---|
| 📦r2x_plexos | 0 | 0 | 0 | -100.0% |
| 📦r2x_plexos | 1 | 1 | 0 | 100.0% |
| 📦models | 1 | 1 | 0 | 100.0% |
| ⚙️base | 3 | 3 | 0 | 100.0% |
| ⚙️battery | 3 | 3 | 0 | 100.0% |
| ⚙️collection_property | 2 | 2 | 0 | 100.0% |
| ⚙️component | 7 | 7 | 0 | 100.0% |
| ⚙️context | 8 | 8 | 0 | 100.0% |
| ⚙️datafile | 3 | 3 | 0 | 100.0% |
| ⚙️fuel | 3 | 3 | 0 | 100.0% |
| ⚙️generator | 3 | 3 | 0 | 100.0% |
| ⚙️interface | 3 | 3 | 0 | 100.0% |
| ⚙️line | 3 | 3 | 0 | 100.0% |
| ⚙️membership | 2 | 2 | 0 | 100.0% |
| ⚙️model | 5 | 5 | 0 | 100.0% |
| ⚙️node | 3 | 3 | 0 | 100.0% |
| ⚙️property | 56 | 56 | 0 | 100.0% |
| ⚙️property_specification | 16 | 16 | 0 | 100.0% |
| ⚙️purchaser | 3 | 3 | 0 | 100.0% |
| ⚙️region | 3 | 3 | 0 | 100.0% |
| ⚙️registry | 7 | 7 | 0 | 100.0% |
| ⚙️reserve | 3 | 3 | 0 | 100.0% |
| ⚙️scenario | 3 | 3 | 0 | 100.0% |
| ⚙️simulation_config | 17 | 17 | 0 | 100.0% |
| ⚙️storage | 3 | 3 | 0 | 100.0% |
| ⚙️timeslice | 3 | 3 | 0 | 100.0% |
| ⚙️transformers | 3 | 3 | 0 | 100.0% |
| ⚙️utils | 2 | 2 | 0 | 100.0% |
| ⚙️variable | 3 | 3 | 0 | 100.0% |
| ⚙️zone | 3 | 3 | 0 | 100.0% |
| ⚙️datafile_handler | 40 | 40 | 0 | 100.0% |
| ⚙️enums_compat | 2 | 2 | 0 | 100.0% |
| ⚙️exporter | 33 | 33 | 0 | 100.0% |
| ⚙️parser | 30 | 30 | 0 | 100.0% |
| ⚙️plugin_config | 7 | 7 | 0 | 100.0% |
| ⚙️utils_exporter | 9 | 9 | 0 | 100.0% |
| ⚙️utils_mappings | 1 | 1 | 0 | 100.0% |
| ⚙️utils_parser | 6 | 6 | 0 | 100.0% |
| ⚙️utils_plexosdb | 7 | 7 | 0 | 100.0% |
| ⚙️utils_simulation | 28 | 28 | 0 | 100.0% |
| Overall (40 files): | 1 | 1 | 0 | 100.0% |