Command Line Options
The LPG has a command line interface to make it easier to auomate calculations. For this you need to call the SimulationEngine.Exe from the command line. Note that the following options are partially out of date. You can always get the most current version by just calling simulationengine.exe from the command line.
The following options are for listing the contents of the database:
| -\-List-Households | Lists all households | ||
|---|---|---|---|
| -\-List-ModularHouseholds | Lists all modular households | ||
| -\-List-Houses | Lists all houses | ||
| -\-List-Settlements | Lists all settlements | ||
| -\-List-TemperatureProfiles | Lists all temperature profiles | ||
| -\-List-GeographicLocations | Lists all Geographic Locations | ||
| -\-List-OutputDefaults | Lists all output defaults. | ||
| -\-List-LoadtypePriorities | Lists all load type priorities. | ||
| -\-List-Loadtypes | Lists the load types |
The following options are for creating batch files to process a lot of households at once:
| -\-Batch-Households | Creates a batch file to calculate one instance of all households | ||
|---|---|---|---|
| -\-Batch-ModularHouseholds | Creates a batch file to calculate one instance of all modular households. | ||
| -\-Batch-Houses | Creates a batch file to calculate one instance of all houses | ||
| -\-Batch-Settlements | Creates a batch file to calculate one instance of all settlements. | ||
| -\-BatchFromSettlement -\-Settlement 3 | Creates a batch file to calculate all the elements in the settlement with the number 3 |
The following options are can also be used:
| -\-LaunchParallel -\-Batchfile bla.cmd | Launches calculations in parallel on as many cores as possible from the batch file bla.cmd.Especially useful in combination with the batch-from-settlement option. | ||
|---|---|---|---|
| -\-CollectPDFs | Collect all PDFs from the subdirectories and make a html file for access (mostly used for generating files for the homepage) | ||
| -\-CollectSettlementResults | Collect all Settlement Results | ||
-\-ImportHouseholdDefinition \|
| Imports a previously exported household definition from a CSV file and creates a .cmd file for calculation |
| |
The following options are used when calculating a single household. These options are required.
| -\-Calculate | Calculation of a single household | ||
|---|---|---|---|
| -\-Household|-\-ModularHousehold|-\-House|-\-Settlement | Set the calculation type. | ||
-\-CalcObjectNumber \|
| Set the calculation object number from the list. |
| |
The following options are optional and can be used to further specify the calculation
-\-StartDate \|
| Sets a start date. No value means the first day of this year |
| |
|---|---|---|---|
-\-EndDate \|
| Sets an end date. No value means the last day of this year. |
| |
-\-Randomseed \|
| Set the random seed |
| |
-\-TemperatureProfile \|
| Set the temperature profile to use. |
| |
-\-LoadtypePriority \|
| Set load types to include. Use --List-LoadtypePriorities to find the number you want. |
| |
-\-GeographicLocation \|
| Set the geographic location to use |
| |
-\-ExternalTimeResolution \|
| Sets the external time resolution to use |
| |
| -\-DeleteAllButPDF | After calculation all files but the PDF are deleted. | ||
| -\-EnergyIntensive | Energy Intensity to use | ||
| -\-EnergySaving | Energy Intensity to use | ||
| -\-EnergyIntensivePreferMeasured | Energy Intensity to use | ||
| -\-EnergySavingPreferMeasured | Energy Intensity to use | ||
-\-OutputDefault \|
| Set the different default modes. This is the basic option to determine which result files and reports should be generated. The other options below work in addition to this mode. |
| |
-\-OutputDirectory \|
| Sets the output directory. If this is not the files will be dumped into the current directory. |
| |
| -\-SkipExisting | Skips this calculation if the directory already exists |
These options can be used if you are using a minimal output default, but want additionally one special result file or report.
| -\-ActionCarpetPlot | Enables the action carpet plots | ||
|---|---|---|---|
| -\-EnergyCarpetPlot | Enables the energy carpet plots | ||
| -\-ActivationFrequencies | Enables the activation frequency report | ||
| -\-ActivationsPerHour | Enables the activations per hour report | ||
| -\-TotalsPerLoadtype | Enables the totals per loadtype report | ||
| -\-TotalsPerDevice | Enables the totals per device report | ||
| -\-HouseholdContents | Enables the household contents report | ||
| -\-TemperatureFile | Enables the temperature report | ||
| -\-DaylightTimesToCSV | Enables the daylight report | ||
| -\-EnergyStorageFile | Enables the energy storage report. Only applicable to houses with energy storages. | ||
| -\-DesiresLogfile | Enables the desires report | ||
| -\-ThoughtsLogfile | Enables the thoughts report | ||
| -\-DurationCurve | Enables the duration curve report | ||
| -\-TimeOfUse | Enables the time of use report | ||
| -\-Weekday | Enables the weekday consumption report | ||
| -\-AffordanceEnergyUse | Enables the affordance energy use report | ||
| -\-ImportFiles | Enables the file for importing on other programs (5 min resolution) | ||
| -\-CriticalViolations | Enables the critical desire threshold violations report (not very useful) | ||
| -\-TimeProfileFile | Enables the time profile report | ||
| -\-SumProfileExternal | Enables the external time resolution sum profile result file | ||
| -\-DeviceProfileExternal | Enables the external time resolution device profile result file | ||
| -\-SumProfile | Enables the internal time resolution sum profile result file | ||
| -\-DeviceProfile | Enables the internal time resolution device profile result file | ||
| -\-Actions | Enables the actions report | ||
| -\-Locations | Enables the Locations report | ||
| -\-HouseholdPlan | Enables the household plan report (only applicable if there is such a household plan) | ||
| -\-Graphics | Enables the creation of charts | ||
| Enables the combining of all charts into one PDF. This is very slow, so only do this if you really want the PDF. |
Example command line:
SimulationEngine.exe -\-Calculate -\-Household -\-CalcObjectNumber 1 -\-OutputDefault 6 -\-DeleteAllButPDF -\-OutputDirectory Household_PDF_1