breos.io#

I/O module for data export and import.

This module provides functions for: - Exporting simulation results to CSV/TXT - Saving cost analysis reports - Generating formatted summary reports

Functions

export_cost_analysis(cost_df, results_directory)

Export cost projection analysis to CSV or TXT.

export_monthly_summary(results_df, ...[, ...])

Export monthly aggregated summary to CSV.

export_results(results_df, results_directory)

Export simulation results to CSV or TXT.

export_summary(summary_df, results_directory)

Export summary statistics as formatted text or CSV.

export_yearly_summary(results_df, ...[, ...])

Export yearly aggregated summary to CSV.

load_results(filepath[, parse_dates])

Load simulation results from CSV or TXT file.

save_simulation_report(results_df, summary_df)

Save complete simulation report with all outputs.
breos.io.export_cost_analysis(cost_df, results_directory, prefix='', suffix='', format='csv', index=False)[source]#

Export cost projection analysis to CSV or TXT.

Parameters:

  • cost_df (DataFrame) – DataFrame from cost_analysis_projection()

  • results_directory (str) – Directory to save the file

  • prefix (str) – Optional prefix for filename

  • suffix (str) – Optional suffix for filename

  • format (str) – Output format (‘csv’ or ‘txt’)

  • index (bool) – Whether to include DataFrame index

Return type:

str

Returns:

Path to the saved file

breos.io.export_monthly_summary(results_df, results_directory, prefix='', suffix='')[source]#

Export monthly aggregated summary to CSV.

Parameters:

  • results_df (DataFrame) – Full simulation results with Datetime index

  • results_directory (str) – Directory to save the file

  • prefix (str) – Optional prefix for filename

  • suffix (str) – Optional suffix for filename

Return type:

str

Returns:

Path to the saved file

breos.io.export_results(results_df, results_directory, prefix='', suffix='', format='csv', index=False)[source]#

Export simulation results to CSV or TXT.

Parameters:

  • results_df (DataFrame) – DataFrame with simulation results

  • results_directory (str) – Directory to save the file

  • prefix (str) – Optional prefix for filename

  • suffix (str) – Optional suffix for filename

  • format (str) – Output format (‘csv’ or ‘txt’)

  • index (bool) – Whether to include DataFrame index

Return type:

str

Returns:

Path to the saved file

breos.io.export_summary(summary_df, results_directory, prefix='', suffix='', format='txt', extra_metrics=None)[source]#

Export summary statistics as formatted text or CSV.

Parameters:

  • summary_df (DataFrame) – Summary DataFrame (typically single row with key metrics)

  • results_directory (str) – Directory to save the file

  • prefix (str) – Optional prefix for filename

  • suffix (str) – Optional suffix for filename

  • format (str) – Output format (‘txt’ for formatted text, ‘csv’ for raw)

  • extra_metrics (Optional[Dict[str, Any]]) – Optional label -> value pairs appended as additional summary fields (e.g. {"LCOE [EUR/kWh]": "0.1327"}). Pre-format float values as strings to control their displayed precision.

Return type:

str

Returns:

Path to the saved file

breos.io.export_yearly_summary(results_df, results_directory, prefix='', suffix='')[source]#

Export yearly aggregated summary to CSV.

Parameters:

  • results_df (DataFrame) – Full simulation results with Datetime index

  • results_directory (str) – Directory to save the file

  • prefix (str) – Optional prefix for filename

  • suffix (str) – Optional suffix for filename

Return type:

str

Returns:

Path to the saved file

breos.io.load_results(filepath, parse_dates=True)[source]#

Load simulation results from CSV or TXT file.

Parameters:

  • filepath (str) – Path to the results file

  • parse_dates (Union[bool, List[str]]) – Whether to parse datetime columns (True, False, or list of column names)

Return type:

DataFrame

Returns:

DataFrame with loaded results

breos.io.save_simulation_report(results_df, summary_df, costs_dict=None, cost_projection_df=None, degradation_df=None, results_directory='results', scenario_name='', economics_metrics=None)[source]#

Save complete simulation report with all outputs.

Generates these files:

  • results_{scenario}.csv: full simulation time series.

  • summary_{scenario}.txt: key metrics summary, including LCOE, payback, and NPV when a cost projection is provided.

  • costs_{scenario}.csv: cost analysis, if provided.

  • degradation_{scenario}.csv: battery degradation data, if provided.

Parameters:

  • results_df (DataFrame) – Full simulation results DataFrame

  • summary_df (DataFrame) – Summary statistics DataFrame

  • costs_dict (Optional[Dict[str, Any]]) – Optional cost parameters dictionary

  • cost_projection_df (Optional[DataFrame]) – Optional cost projection DataFrame

  • degradation_df (Optional[DataFrame]) – Optional degradation tracking DataFrame

  • results_directory (str) – Directory to save all files

  • scenario_name (str) – Scenario identifier for filenames

  • economics_metrics (Optional[Dict[str, Any]]) – Optional label -> value pairs added to the summary, overriding any figures auto-derived from cost_projection_df.

Return type:

Dict[str, str]

Returns:

Dictionary mapping file types to saved file paths