This directory is for data and code to import IPM results from single Microsoft Excel files. Splitting the Excel files into sheets and other files in an initial step greatly reduces overall processing time.
| Directory Name | Description |
|---|---|
ipm |
Contains IPM result Excel files to be imported |
data |
Processed Excel and R data files generated from the IPM results |
The data directory structure is shown below:
├───build
│ ├───data
│ │ └───2025_mats_repeal_final
│ │ ├───baseline
│ │ ├───other_input_data
│ │ └───policy
│ └───ipm
│ └───2025_mats_repeal_final
│ ├───baseline
│ ├───other_input_data
│ └───policy
Import ipm results from Excel by splitting a single Excel workbook into multiple Excel files based on their sheet name to be processed by the core scripts.
| Data | Location |
|---|---|
| input | IPM results data files from the build/ipm/<RIA name> directory |
| output | Creates the data files in the build/data/<RIA name> directory |
Each RIA directory within the ipm directory contains a standardized directory structure containing the IPM results from the base case results, policy case results, and auxiliary IPM input data.
| Directory | Description |
|---|---|
build/ipm/<RIA name>/baseline |
Contains IPM results for the baseline scenario |
build/ipm/<RIA name>/policy |
Contains IPM results for the policy scenario |
build/ipm/<RIA name>/other_input_data |
Contains auxiliary IPM input data used in the analysis |
preprocess_big_xlsx_data.R processes the IPM results from the build/ipm/<RIA name>/baseline and build/ipm/<RIA name>/policy directories and saves the processed data files to the build/data/<RIA name>/baseline and build/data/<RIA name>/policy directories, respectively. Files from the build/ipm/<RIA name>/other_input_data directory are used later in the build process.
The build process uses IPM output files from the "Detailed Model Operational Outputs" (RPT files) and input files from "Model Inputs" (DAT files). Below is a summary of the standard IPM input/output files used to build the SAGE input file.
| File Name | IPM Data | Description |
|---|---|---|
<IPM case name> DAT File.xlsx |
Input, Dat file | Key input set-up data used to define the model run |
<IPM case name> Cost_TotalAnnual.xlsx |
Output, RPT file | Costs |
<IPM case name> FuelSupply.xlsx |
Output, RPT file | Fuel supply use |
<IPM case name> RegionalSummary.xlsx |
Output, RPT file | Regional summaries |
<IPM case name> TransmissionSummary.xlsx |
Output, RPT file | Electricity transmission |
In addition to the base and policy case IPM results, preprocess_big_xlsx_data.R, also imports the NEEDS database file located in the build/ipm/<RIA name>/other_input_data directory. The NEEDS database file is a standard IPM input file provided with the documentation.
| File Name | IPM Data | Description |
|---|---|---|
NEEDS <IPM case name>.xlsx |
Input | NEEDS database |
The remaining auxiliary IPM input files are used later in the build process. These file are located in the build/ipm/<RIA name>/other_input_data directory.
Tax Credits and EOR.xlsx, is a non-standard IPM input file that contains estimates of the tax/subsidy transfers for a congressional legislation which impose taxes and/or credits to the power sector. This file is created outside of IPM and provided to EPA alongside IPM outputs.| Script Used | File Name | Description |
|---|---|---|
04_aggregating_ipm_output.R |
Tax Credits and EOR.xlsx |
Tax/credit estimates |
Table 1_Real.xlsx, is a non-IPM related input file that contains estimates of the transportation and delivered costs of coal by year and primary transport mode. This file is created outside of IPM and provided by the US Energy Information Administration here.| Script Used | File Name | Description |
|---|---|---|
04_aggregating_ipm_output.R |
Table 1_Real.xlsx |
Real Average Transportation and Delivered Costs of Coal, By Year and Primary Transport Mode |
preprocess_big_xlsx_data.R saves the imported IPM result scenario and NEEDS data to the build/data directory.
| Directory | Description |
|---|---|
build/data/<RIA name>/baseline |
Contains IPM results for the baseline scenario |
build/data/<RIA name>/policy |
Contains IPM results for the policy scenario |
build/data/<RIA name>/other_input_data |
Contains auxiliary IPM input data used in the analysis |