This package creates figures and an HTML file with all of those figures for plexos solutions.
- You must use process_folder() from the rplexos package to create a database file from the PLEXOS solution .zip, before running this code.
- The Examples folder contains templates and examples of the input data CSV, the generator name, region, and zone mapping CSV, the R script that runs the package, and example HTML reports (within the reports folder).
- Section_guide.md lists what sections correspond to each number for the sections to run column in the input data CSV file.
- UserInterface_InputData contains a shiny (r package) graphical user interface that will create the input_data.csv file automatically based on what sections you want to run. Either run the app, or open the ui.R in RStudio and click "Run App" to open a new window which allows the user to select which sections to run. It then prompts the user to input the necessary data. Click "Create input CSV file" to create the csv file.
- Copy run_html_output.R and input_data_template.csv from the Examples/ folder into another folder associated with your project specific repository.
- Edit input_data.csv according to your model. Some of these values may be defined in run_html_output.R
- If using a CSV to map generator name to type, create this.
- If generation type by region or zone is wanted, add region and zone columns to mapping CSV.
- Edit Examples/run_html_output_template.R to point to your input_data.csv and databases. You may point to multiple databases by listing a vector of database locations. Additionally, you may specify 'scenario.names' to re-name the scenario for each database. Default is the folder name.
- Edit run_html_output.R to set html output file name, directory and current working directory where files are located.
- Run:
source('run_html_output.R')
- If you have trouble with the render function, make sure the "rmarkdown" package is installed. If there are issues locating or sourcing files, make sure the appropriate working directories and paths are setup correctly.
- You can choose to run individual chunks or the entire package. This is setup in the input_data.csv file. Running the entire package could take a long time, particularly for large solution files and if the solution file has to be processed by rplexos (done the first time MAGMA is run).
- The name of your database file must start with "Model".
- Report any problems or issues to Matt O'Connell or Brady Stoll at NREL. matthew.oconnell@nrel.gov or Brady.Stoll@nrel.gov
- ref.scenario
- Name of reference scenario if comparing multiple solution files. Only used if more than one database is provided. Scenario name must be the name of the folder where the solution file is contained. Each different scenario's solution must be in its own individual folder. If multiple database solutions are provided and no ref.scenario is specified, the first one listed will default to the base or reference scenario.
- PLEXOS.Gen.Category
- Categories in PLEXOS database. This must contain all the categories in your PLEXOS database.
- Only required if "use.gen.type.csv" or "Using.Gen.Type.Mapping.CSV" is FALSE.
- PLEXOS.Desired.Type
- Assigns a generation type to each of the PLEXOS categories.
- Only required if "use.gen.type.csv" or "Using.Gen.Type.Mapping.CSV" is FALSE.
- Gen.Type
- All types of generation that you either assign through the CSV or PLEXOS category. It can contain more types than you currently have, but it must have all of them otherwise they will be missing from the results.
- Plot.Color
- Assigns a plot color to each generation type
- Gen.Order
- Assigns an order from top to bottom of generation types for dispatch stacks. This list must also contain every generation type that you assign.
- Renewable.Types.for.Curtailment
- Generation types to be considered in curtailment calculations.
- DA.RT.Plot.Types
- Types of generation to show in the committment and dispatch plots.
- Key.Periods
- You can choose individual time spans to plot results for. This column assigns names to those time periods.
- Start.Time
- Corresponding start time for each of the periods in 9.
- End.Time
- Corresponding end time for each of the periods in 9.
- Ignore.Zones
- Zones to exclude from plots
- Ignore.Regions
- Regions to exclude from plots
- Interfaces.for.Flows
- Specific interfaces to show flow data for
- If all interfaces are desired, list 'ALL' as only entry
- Lines.for.Flows
- Specific lines to show flow data for
- If all lines are desired, list 'ALL' as only entry
- Sections.to.Run
- Sections (chunks) of the HTML_output.Rmd file to run.
- Region.Order
- Optional column specifying a certain order for Regions to appear in your plots.
- Defaults to alphabetical
- Zone.Order
- Optional column specifying a certain order for Zones to appear in your plots.
- Defaults to alphabetical
- Scenario.Names
- Optional columns to specify the names of your scenarios. Default is the folder name where the solution file is contained.
PLEXOS must report the following data in order for all of the scripts to work. If you try to run a section and are missing the required data you will get an error telling you what PLEXOS output data is missing (or that the query had an error). The section_guide.md file specifies what outputs are required for each individual section. The below list is if every section was run (this can take a long time for larger databases).
- Generation
- Available Energy
- Emission Cost
- Fuel Cost
- Start and Shutdown Cost
- VO&M Cost
- Installed Capacity
- Load
- Imports
- Exports
- Unserved Energy
- Load
- Imports
- Exports
- Unserved Energy
- Provision
- Shortage
- Provision
- Flow
- Flow
- Generation
- Available Capacity
- Units Generating
- Pump Load
- Load
- Price
- Unserved Energy
- Load
- Price
- Unserved Energy
- Provision
- Price
- Provision
- Flow
- Flow