Exporting PLEXOS Data¶

Export System to XML¶

from r2x_plexos import PLEXOSExporter, PLEXOSConfig

config = PLEXOSConfig(model_name="Base", horizon_year=2024)
exporter = PLEXOSExporter(config, system)

result = exporter.export()
assert result.is_ok()

Select a PLEXOS Version Template¶

The exporter initialises the PLEXOS database from a master XML template bundled with the plexosdb package. Use the template field in PLEXOSConfig to pick the target PLEXOS version:

Key	PLEXOS version	File (from `plexosdb`)
`"PLEXOS9.0"`	9.x (9.2R6)	`master_9.2R6_btu.xml`
`"PLEXOS10.0"`	10.x (10.0R2)	`master_10.0R2_btu.xml`
`"PLEXOS11.0"`	11.x (11.0R4)	`master_11.0R4_btu.xml`
`"PLEXOS12.0"`	12.x (12.0R3)	`master_12.0R3_btu.xml`

When template is omitted the default is "PLEXOS10.0".

# Target PLEXOS 9
config = PLEXOSConfig(model_name="Base", horizon_year=2024, template="PLEXOS9.0")

# Target PLEXOS 12
config = PLEXOSConfig(model_name="Base", horizon_year=2024, template="PLEXOS12.0")

# Use a custom XML file on disk
config = PLEXOSConfig(model_name="Base", horizon_year=2024, template="/path/to/my_template.xml")

Export with Custom Configuration¶

from r2x_plexos.models.simulation_config import PLEXOSPerformance, PLEXOSSTSchedule

config = PLEXOSConfig(
    model_name="MyModel",
    horizon_year=2024,
    simulation_config={
        "performance": PLEXOSPerformance(
            name="Test_Perf",
            solver=4,
            mip_relative_gap=0.02,
        ),
        "st_schedule": PLEXOSSTSchedule(
            name="Test_ST",
            transmission_detail=1,
            heat_rate_detail=2,
        ),
        "diagnostic": None,  # Test that None values are skipped
    }
)

exporter = PLEXOSExporter(config, system)
result = exporter.export()

Include Default Properties¶

# By default, exporter excludes properties with default values
# Include all properties:
exporter = PLEXOSExporter(
    config,
    system,
    exclude_defaults=False
)

Set Custom Scenario Name¶

exporter = PLEXOSExporter(
    config,
    system,
    plexos_scenario="custom_scenario"
)

Handle Export Errors¶

result = exporter.export()

if result.is_err():
    print(f"Export failed: {result.error}")
    # Handle error
else:
    print("Export successful")

Round-Trip Export¶

from pathlib import Path
from r2x_core import DataStore, DataFile
from r2x_plexos import PLEXOSParser, PLEXOSExporter, PLEXOSConfig

# Parse
config = PLEXOSConfig(model_name="Base", horizon_year=2024)
store = DataStore(path=Path("input"))
store.add_data(DataFile(name="xml", glob="*.xml"))

parser = PLEXOSParser(config, store)
system = parser.build_system()

# Export
export_config = PLEXOSConfig(model_name="Modified", horizon_year=2024)
exporter = PLEXOSExporter(export_config, system)
result = exporter.export()

Specify Output Directory¶

# Output location is derived from config
config = PLEXOSConfig(
    model_name="MyModel",
    horizon_year=2024,
    timeseries_dir=Path("output/timeseries")
)

exporter = PLEXOSExporter(config, system)
# XML will be in output/, CSV files in output/timeseries/

Validate Export¶

# Validation is built into export workflow
result = exporter.export()

# Or validate separately
validation = exporter.validate_export()

Use Existing PlexosDB Object instead of creating a new one¶

This is for testing only

from plexosdb import PlexosDB

# Create or load existing database
db = PlexosDB(xml_fname="template.xml")

# Use with exporter
exporter = PLEXOSExporter(config, system, db=db)