Skip to main content

iPool Commandline Options

This section provides an overview of the different batch files used in iPool and the commandline options available for each. Each batch file has its own set of options and arguments that control how it operates. The tabs below list the most common batch files for specific scenarios and each utility. Each tab contains command‑line options, expected arguments, and a description of what each option does.

Initialize Database

DefInIt.bat
OptionDescriptionArgument
-ipdbInitializes the input databaseSysWESM25.94.mdb
-tpdbInitializes the time periods databaseTimePeriods.mdb
-ibdbInitializes the bidding databaseiBidWESM.mdb
-ifdbInitializes the flow databaseiFloWESM.mdb
-isdbInitializes the scenario databaseiScen.mdb
-5mnDispSets the time interval to 5 minutes1 = enabled, 0 = disabled

Historical Bids

RunBids.bat

RunBids.bat

OptionDescriptionArgument
-izeroSet MW bids to zero for missing interval bids (enabled by default)1 = enabled, 0 = disabled
-bdorRead RTDOR files and set spinmax/spinres priorities based on reserve MW bids(No argument required)
-tSets the start date of bidsyyyyMMdd

Historical Load

RunHistorical.bat
OptionDescriptionArgument
-newCreates a new scenario(No argument required)
-tSets the start date of the historical run“MM/dd/yyyy”
-ndaysSets the number of days for simulationAny whole number (user-defined)
-repSets the number of report files0 = minimum, 3 = maximum
-5mnDispSets the time interval to 5 minutes1 = enabled, 0 = disabled
-GenListSaves the latest genlist.csv file providedFile name as saved
-sSaves a fileUser-defined file name
-xCloses a file(No argument required)
-oOpens a file(No argument required)
-updatedbAutomatically updates the database with detected changes to sites and units(No argument required)
-checkinputsChecks if the input files are complete(No argument required)
-rbRetains loaded bids(No argument required)
-bDAPShifts logic to Day Ahead Projection (DAP) instead of RTD (Optional)(No argument required)
-bWAPShifts logic to Week Ahead Projection (WAP) instead of RTD (Optional)(No argument required)

Backcast Calibration

RunBackcast.bat
OptionDescriptionArgument
-dLoad demand fileFile name (e.g., Demand_HISTORICAL.csv, DemandHR_HISTORICAL)
-gLoad generation fileFile name (e.g., MRGCFac_HISTORICAL.csv, MRHCFac_HISTORICAL.csv)
-abAutobid loading, extract outages for x hoursAny whole number
-abfSets the site type of outagesALL, COAL, or CCGT
-eLoad event fileFile name (e.g., Ev_Historical.csv)
-pcsrAdjust the reserve calibration factorAny number from 0.1 to 100
-btIncludes only bids within the specified calendar time periodWORKDAY, SAT, SUN, DEFAULT, DEFAULT_PRIORITY
-bfLoads the custom bid with a specified time period (-bt)File name as saved.
Example: 01GNPD_U01.bid
-spinSets the spinning reserves1 = enabled, 0 = disabled

Aggregate Bids

RunBidAgg.bat
OptionDescriptionArgument
-tSpecifies start date of files to processyyyyMMdd
-capIncludes all bids or bids with available capacity above the specified percentage (0–100).Any number between 0 and 100.
Example: -cap 0
Includes all bids or bids with above 0% avail capacity.
-cap_COALIncludes only bids with available capacity equal to or greater than the specified percentage (0–100) for COAL type units.Any number between 0 and 100.
-cap_CCGTIncludes only bids with available capacity equal to or greater than the specified percentage (0–100) for CCGT type units.Any number between 0 and 100.
-cap_HYDROIncludes only bids with available capacity equal to or greater than the specified percentage (0–100) for HYDRO type units.Any number between 0 and 100.
-cap_GEOIncludes only bids with available capacity equal to or greater than the specified percentage (0–100) for GEO type units.Any number between 0 and 100.
-btIncludes only bids within specified calendar timeWORKDAY, SAT, SUN, DEFAULT, or DEF_PRIORITY
-sSaves the aggregated bid fileFile name
-logOutputs a log file reporting empty bids removed(No argument)

What-if Scenarios

RunWIF.bat
OptionDescriptionArgument
-dLoad demand fileFile name (e.g., DemandHR_HISTORICAL.csv)
-gLoad generation fileFile name (e.g., MRHCFac_HISTORICAL.csv)
-outForced unit outageUnit ID (e.g., 01SUAL_G01)
-dxMultiply demand by a valueExample: -dx 1.02 (increase by 2%)
-opELPOptimize bids for Energy Limited Plants(No argument)
-bsetLoad a CSV file containing bidsFileName.csv
-btApply bid to time periodDEF_PRIORITY or DEFAULT
-bfLoad bid fileFileName.bid
-ibLoad intelligent bid fileFileName.ibd
-UnitsFileUpdate site from CSV fileUnits.csv
-SitesFileUpdate site from CSV fileSites.csv
-StorsFileUpdate storages from CSV fileStorages.csv
-storInclude storagesALL or Storage ID (e.g., KALAYAAN)

Forecast

RunFC.bat
OptionDescriptionArgument
-sSets the file name of a scenarioFile name
-dLoad the forecasted demand fileFile name (e.g., DemandForecast.csv)
-gLoad the forecasted generation fileFile name (e.g., GenerationForecast.csv)
-bsetLoad a CSV file that contains bidsFileName.csv
-pcsrAdjust the Reserve Calibration FactorAny number from 0.1 to 100
-eLoad an event fileFile name (e.g., Events.csv)
-rRandom seed for Monte Carlo simulation100
-nNumber of Monte Carlo samplesAny number ≤ 100 (e.g., 100) depending on user's requirements

Add Custom Storage

RunSTO.bat
OptionDescriptionArgument
-dLoad demand fileFile name (e.g., DemandHr_HISTORICAL.csv)
-gLoad generation fileFile name (e.g., MRHCFac_HISTORICAL.csv)
-abAutobid loading, extract outages for x hoursAny whole number
-abfSets the site type of outagesALL, COAL, or CCGT
-eLoad event fileFile name (e.g., Ev_Historical.csv)
-esetLoad set of event fileFile name (e.g., Evset_Historical.csv)
-pcsrAdjust the reserve calibration factorAny number from 0.1 to 100
-btIncludes only bids within the specified calendar time periodWORKDAY, SAT, SUN, DEFAULT, DEFAULT_PRIORITY
-bfLoads the custom bid with a specified time period (-bt)Filename.bid
-spinSets the spinning reserves1 = enabled, 0 = disabled
-opELPOptimize bids for Energy Limited Plants(No argument)
-UnitsFileUpdate unit from CSV fileUnits.csv
-SitesFileUpdate site from CSV fileSites.csv
-StorsFileUpdate storages from CSV fileStorages.csv

Zonal Configuration

RunZones.bat
OptionDescriptionArgument
-setzonesConverts regions to zones(No argument required)
-nowinOpens a file without a Windows pop‑up(No argument required)
-ipdbSets iPool database systemFileName.mdb

Create Custom Bids

RunBidEzy.bat
OptionDescriptionArgument
-unitCreates an empty bid file containing only the specified unitUnit ID
Example: 01SUAL_G01
-sSave the file as FileName.bidFileName.bid
-bid_flatCreates a flat bid of the specified price to all the bids in the currently loaded bid file. If price is 0, the price defaults to the corresponding SRMC of each unit in the bid file. The bid quantity is set to the maximum MW of each unit.Bid price
(depending on user’s requirements)
bid_peakCreates a peak bid of the specified price to all the bids in the currently loaded bid file. If price is 0, the price defaults to the corresponding SRMC of each unit in the bid file. The bid quantity is set to the Max MW of each unit.Bid price
(depending on user’s requirements)
-bid_popCreates a peak-offpeak bid of the specified peak price to all the bids in the currently loaded bid file. The off peak price defaults to the corresponding SRMC of each unit in the bid file. The bid quantity is set to the Max MW of each unit.Bid price
(depending on user’s requirements)
-swapReplaces the corresponding bid from the existing bid file or adds the bid to the file if there is no corresponding bidFileName.bid