Importing and Exporting Data

PlexosDB provides methods for importing data from XML files and exporting to XML or CSV formats.

Importing from XML

Create a database from an existing PLEXOS XML file:

from plexosdb import PlexosDB

# Create database from XML
db = PlexosDB.from_xml("/path/to/model.xml")

# Check PLEXOS version of the imported model
version = db.version
print(f"Imported PLEXOS model version: {version}")

Importing a PLEXOS solution ZIP and reading report tables

Use PlexosSolution when you want to analyze PLEXOS solution ZIP outputs. With the default materialize="none", you can materialize only the table you need.

from plexosdb.solution_reader import PlexosSolution
import pandas as pd

PLEXOS_SOLUTION = "/path/to/solution.zip"

sol = PlexosSolution.from_zip(PLEXOS_SOLUTION)
sol.to_sqlite("output.sqlite", if_exists="replace")

table = "ST__Interval__Regions__Fixed_Load"
sol.materialize_table(table, schema="report")
df_table = pd.read_sql_query(f'SELECT * FROM report."{table}"', sol.connection)

How to use this flow:

1. Create a PlexosSolution via PlexosSolution.from_zip(zip_path).

2. Call to_sqlite(path, if_exists="replace") to import the ZIP into SQLite. Use materialize="none" (default) to avoid materializing every derived table up-front.

3. Call materialize_table(table, schema="report") for the specific table you want.

4. Read that table with pandas using pd.read_sql_query(...) and sol.connection.

Exporting to XML

Export your database to a PLEXOS-compatible XML file:

from pathlib import Path

# Export the entire database to XML
output_path = Path("/path/to/output_model.xml")
success = db.to_xml(output_path)

if success:
    print(f"Model exported successfully to {output_path}")
else:
    print("Export failed")

Importing from CSV

Import data from CSV files:

# Import specific tables from CSV files
db.import_from_csv(
    "/path/to/csv_directory",
    tables=["t_object", "t_data", "t_property"]
)

Exporting to CSV

Export database tables to CSV files:

# Export all tables to CSV
db.to_csv("/path/to/output_directory")

# Export specific tables
db.to_csv(
    "/path/to/output_directory",
    tables=["t_object", "t_data", "t_property"]
)

Database Backup

Create a backup of your in-memory database:

# Backup the database to a file
db.backup_database("/path/to/backup.db")

Creating and Optimizing Databases

# Create an empty database
db = PlexosDB()
db.create_schema()

# After making many changes, optimize the database
db._db.optimize()

Converting Between Formats

Converting from XML to CSV:

# Import from XML then export to CSV
db = PlexosDB.from_xml("/path/to/model.xml")
db.to_csv("/path/to/csv_output")

Warning

When working with large files, ensure you have sufficient memory and disk space for the operations.