The RiverSystem.CommandLine.exe provides a mechanism to run existing projects without the Source interface. It is possible to modify or change the behaviour of the project from the command line, by changing the values of functions. Results can be returned for recorded items or functions within the project.
RiverSystem.CommandLine.exe is included with Source.
...
Figure 1. Manipulating functions
The MetaParameter Explorer can be used to attach functions directly to model variables for situations where the Function Editor has not been enabled by default.
...
By default, all recorded items are returned, as configured from within the Source application (Running scenarios). Alternatively, you can specify specific items to record by using a command line argument:
...
- Using the Function Manager directly;
- Creating a function and Adding function usages manually; or
- Using the Calibration Wizard. Refer to Working with metaparameters for more information.
| Info | ||
|---|---|---|
| ||
Note: When working with functions in the command line, ensure that functions are referenced by their full name to avoid errors or run failures. The syntax for referencing a function by its full name is $Folder.Function. For example, use: RiverSystem.CommandLine.exe -v "$Folder1.Function1=10" |
...
Display option commands | Function | Example | |||||
|---|---|---|---|---|---|---|---|
-a, --address | Address for server to create, or client to connect. | -a "net.pipe://localhost/PipeReverse" or "net.tcp://localhost:8523/eWater/Services/RiverSystemService" | |||||
-b, --baseSIUnits | Ignore units set within project and output base SI units | --baseSIUnits | |||||
-c, -rec, --recording | File to load state from when in client mode or file to save state in when in server mode. | -c "c:\StateFiles\state.txt" | |||||
--cp, --configurationproperty | Run configuration property. | --configurationproperty "name=value" | |||||
-d, --directory | Directory in which to look for projects. | -d "c:\ProjectFiles" | |||||
-e, --timeout | Operation timeout for WCF service in seconds. | -e 2000 | |||||
-et, -endtime | The end Data/Time of the scenario run. | --endtime "1/1/2011" | |||||
-f, --settingFile | File to merge command-line settings from. | -f "settings.txt" | |||||
-?, --help | Show usage help | -? | |||||
--is, --inputset | The Scenario Input Set to use for this run. | --inputset "ScenarioInputSetName" --inputset "ScenarioInputSetName.ChildInputSetName" | |||||
--ip, --inputSetProperty | Scenario Input Set property. These are Scenario input set parameter lines. If you are using child input sets, these are applied after the last child input set. See: Scenario Input Sets | --ip "Functions.Functions.$MyFunction.Expression = 0.25" --ip "Nodes.InflowNode.Flow =20 ML/d" | |||||
-l, --loadPlugin | This option allows a plugin (that the project has been saved with) to be loaded for this run only. The path specified is a relative path to the plugin from the command line. eg. "Plugins\ExampleRainfallRunoffModel.dll" | -l "plugin.dll" | |||||
-m, --mode | Application mode Client/Server/InProcess. | -m Client or -m Server | |||||
-o, --output | File to save output into. The extension selects the output format based on the standard TIME I/O formats. A directory of the name specified will be created if the format only supports a single time series. | -o "output.res.csv" for CSV or -o "output.nc" for NetCDF etc. | |||||
-p, --project | Path to the project, or project name on server and optional scenario within that project, DateTime values to override the default start and end times of the loaded scenario and data source input set to run. | -p "projectName.rsproj", or to specify the scenario within the project | |||||
-md, --ProjectMetadata | Display the metadata for the given project | --ProjectMetadata | |||||
-r, --results | Which results to return. This can appear multiple times.
| -r "someResult" -r "someOtherResult" | |||||
--resultsOutputMode | Specifies the way output is created. 3 options are available: ClientNamedFormat ServerNamedFormat NoOutput "ClientNamedFormat" - Results fetched to client, saved to output file from there, in a format based on output file extension. Default for Client mode. Only valid for Client mode. "ServerNamedFormat" - Results saved to output file directly from server, in a format based on output file extension. Does not fetch results to client. This "server side" save is more efficient. Default for InProcess mode, since "server side" is local here. Can be used in Client mode, assuming the end user has access to the path provided to the server. "NoOutput" - Does not save results anywhere, hence does not fetch results either. Can be used where the result data files are ignored. E.g. in tests, or where a plugin gives a different pathway to results. | --resultsOutputMode NoOutput -o "..\cmdlineResult.res.csv" --resultsOutputMode ServerNamedFormat | |||||
-rc, --runconfiguration | Allows you to set the running configuration to be used for the run. | -rc "Flow Calibration" | |||||
--scenario | Specify the scenario name | --scenario "New Scenario" | |||||
--starttime | The Start Time for the scenario run | --starttime "1/1/2011" | |||||
-s, --step | Number of time-steps to run. | --step 1 | |||||
-t, --reset | Reset the loaded project. | --reset | |||||
-u, --current | Return only the current time step's value for the specified results | --current | |||||
-y, --saveAs | Save the loaded project after the run is complete to the specified path and file. The string argument cannot be empty, and the path provided must be an existing directory and have saving permissions for the current user. | -y "C:\ProjectFiles\newProject.rsproj" |
| Anchor | ||||
|---|---|---|---|---|
|
When using a running configuration other than the default Single Analysis, there can be additional configuration properties available. These are handled with the -cp command.
-cp, --ConfigurationProperty
When using River Operations, you can specify the additional properties listed in the table below:
Operations Configuration Property | Data | Example |
|---|---|---|
WarmUpStart | Date Time | -cp "WarmUpStart=1/1/2017" |
| ReloadOnRun | Boolean | -cp "ReloadOnRun=True" |
| Today | Date Time | -cp "Today=1/1/2018" |
| ForecastLength | Positive integer | -cp "ForecastLength=90" |
DataUpdatePeriod | Positive integer | -cp "DataUpdatePeriod=15" |
For details about these parameters, please see: Operations forecasting
PEST calibration using the command line
PEST (Parameter ESTimation and uncertainty analysis) allows analysis of complex environmental models, and can be used in Source for calibration of catchments. You can use the command line to do calibration and uncertainty in a catchments model. The steps to do the calibration are as follows:
- Starting with a Source Catchment project file, use the Calibration Wizard to set up ‘functions’ for the parameters of the rainfall runoff models.
When defining the metaparameters in the Calibration Wizard, the list of Existing Metaparameters will be used in the parameter file for invoking RiverSystem.CommandLine; - Turn on any recorders for the hydrological quantities that will be used in the objective function. In step 4 of the Calibration Wizard, choose Manual optimisation and enable Create functions for use from an external tool;
- Save the project;
- Set up the RiverSystem.CommandLine input file;
- Setup the PEST input and template files;
- Prepare a batch file to invoke the commandline and pre-processors; and
- Run PEST.
Once the Calibration wizard has been set up, start the command line server (RiverSystem.CommandLine.exe -p projectname.rsproj -m server) and then PEST (pest pestcontrolfile.pst).
Batch running using the command line
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Refer to Batch running using the command line in the Source community for details and an example.