Compute the specified statistic for slots in an ensemble data set. For more information on Ensemble Data Sets, see Ensemble Data Tool in Solution Approaches. Statistics are computed for each selected slot at each timestep across traces. The outcome are one or more time series of results for each selected slot.

See Analyzing Data Sets in Solution Approaches for more information on interactive use of this action in the Ensemble Data Tool.

For more information on a similar action to visualize the ensemble data set, see Visualize Ensemble Data Set.

Results are written to a set of series slots or agg series slots, one for each slot included in the analysis. Results can be written to the same object as the source slot, a results data set object, or both. When written to the same object as the source slot, the results slot’s name is created using the template: “<slot’s object>.<slot name> <results slot tag>”. For example, if the slot “Res A.Inflow” participates in the analysis and the Results Slot Tag is “Median”, then results associated with that slot will be written to the slot “Res A.Inflow Median”.

When written to a results data set object, the results slot name is created using the template: “<results data set name>.<slot’s object> <slot name><results slot tag>. For the same example of the slot “Res A.Inflow” and the Results Slot Tag of “Median” and a Results Data Set Name “Analysis Data Set,” the results will be written to the slot “Analysis Data Set.Res A Inflow Median”.

If the Write Results to Simulation Objects is “yes”, the action will create the data set series slot if it does not already exist and, if it does exist, resize it as necessary to the minimum required dimensions. All values are given the input (I) flag. If the results slot is an agg series slot and the results slot column value is other than zero, the results are written to that column of the results slot.

If the Write Results to Data Set is “yes”, the action will create the data set series slots on a new or existing Ensemble Data Object with the given tag in the slot name. All values are given the output (O) flag but are read only.

In the Analysis Type setting, specify the statistic to compute for each timestep across traces. Options are:

For the above function, note that three arguments are used, values, slot, and obj. The date is defined but not used in the body

The predefined function GetEnsembleDatum is also very useful as you can get the value of a slot for a trace and a datetime. See GetEnsembleSeriesValue in RiverWare Policy Language (RPL). With this predefined function, you can create a function that counts the number of traces where a trace slot is greater than another trace slot.

Apply a window layout created with the Window Manager. See Window Manager in User Interface.

Clear the values set by a DMI (by using the DMI invocation manager functionality).

Clear the values on a set of Scalar Slots (i.e. set them to NaN).

Clear one or more values on a set of Table slots (i.e. set them to NaN).

Compute duration curves for a set of series slots across multiple traces and timesteps from an ensemble data set. (For more information on Ensemble Data Sets, see Ensemble Data Tool in Solution Approaches.) The results are written to table slots (one results table slot for each input slot) with a format similar to a statistical table slot using the Duration Curve function (see Statistical Table Slots in User Interface) with all of the slot values sorted (ranked) from largest to smallest. The results table has five columns: Percent of observations equaled or exceeded, the slot values, Rank, Date, and Trace.

Results are written to a set of table slots, one for each slot included in the analysis. Results can be written to the same object as the source slot, a results data set object, or both. When written to the same object as the source slot, the results slot’s name is created using the template: “<slot’s object>.<slot name> <results slot tag>”. For example, if the slot “Res A.Inflow” participates in the analysis and the Results Slot Tag is “Duration Curve”, then results associated with that slot will be written to the slot “Res A.Inflow Duration Curve”.

When written to a results data set object, the results slot name is created using the template: “<results data set name>.<slot’s object> <slot name><results slot tag>. For the same example of the slot “Res A.Inflow” and the Results Slot Tag of “Duration Curve” and a Results Data Set Name “Analysis Data Set,” the results will be written to the slot “Analysis Data Set.Res A Inflow Duration Curve”.

The action will create the results table slot if it does not already exist and, if it does exist, resize it and change column units and column labels as necessary.

Perform a multiple linear regression analysis on an ensemble data set. (For more information on Ensemble Data Sets, see Ensemble Data Tool in Solution Approaches.) The dependent variable and independent variables must be scalar slots. The primary outputs, the regression coefficients, are written to one table slot. Four other table slots are written out with statistical information about the solution quality. Details are provided below.

The Compute Regression action uses the ordinary least squares approach to compute the regression coefficients for a linear equation of the following form.

The dependent variable and independent variables are scalar slot outputs from an ensemble that are part of an existing ensemble data set.

Results can be written to an existing object on the workspace (not an ensemble data set object), a results data set object, or both.

The five results table slots from the Compute Regression action must be specified in the associated five settings. Leaving one of the result slot name settings empty will result in an error when the action is executed. If the results slot does not exist, it will be created when the script action executes. If the results slot does exist, it will be resized as necessary to fit the regression results. The units on each of the columns of the results slots will be modified as necessary to have the appropriate units from the regression analysis. For results slots on standard objects (non-data set objects) row and column labels can be edited. Any existing column and row labels will be maintained. Results slots written to results data set objects will always have default column and row labels that cannot be edited. The five results slots are described below.

For the specified MRM configuration, modify the configuration in terms of Index Sequential. This is shown on the Input tab in the MRM configuration. See Index Sequential in Solution Approaches for details.

For the specified MRM configuration, modify the configuration in terms of Input DMIs, particularly the repeat count. This is shown on the Input tab in the MRM configuration. See Input in Solution Approaches for details.

For the specified MRM configuration, modify the configuration in terms of the Output. This is shown on the Output tab in the MRM configuration. See Output in Solution Approaches for details.

For the specified MRM configuration, modify the first trace and number of traces.

For the specified Trace Directory DMI, set the Trace Number to use when the DMI is executed outside of MRM. See Trace Directory DMI in Data Management Interface (DMI) for details.

Create an ensemble data set object from an RDF file. This action will create an ensemble data set object on the workspace and will add the data set to the Ensemble Data Tool. For more information on Ensemble Data Sets, see Ensemble Data Tool in Solution Approaches.

If an ensemble data set or any object with the same name already exists, an error will be issued. A Delete Ensemble Data Set action can be included before this action to always guarantee that any existing ensemble data set with this name will get deleted before trying to create the new ensemble data set.

Creates a slot cache that contains the current values of all series slots on the workspace, in the range of the current controller. See Slot Cache in User Interface for details on the cache.

Create a Snapshot of the specified slots.

Delete the selected custom slots.

Remove an ensemble data set. This will delete the associated object and slots from the workspace. For more information on Ensemble Data Sets, see Ensemble Data Tool in Solution Approaches.

Delete a link between the two specified slots. For more information on links, see Linking Slots on Objects in Getting Started Building a Model. It is not an error if the two slots are not linked. See also the complimentary action to Link Slots.

Delete the selected objects.

Delete all of the optimization restore points currently in existence. For more information on optimization restore points, see Restore Point in Optimization.

Delete any snapshot objects older than a specified number of days.

This item adds a divider to the Script Editor and Script Dashboard. It does not do anything in script execution; it is strictly for to provided a visual separation between actions. The Display Text can be used to add text to the divider.

For the specified objects, enable or disable the dispatch method execution. When disabled, the object icons on the workspace and in other dialogs appear dimmed.

For the specified MRM configuration, specify whether to distribute concurrent runs to multiple processors on the same machine. See Distributed Concurrent Runs in Solution Approaches for details on distributed MRM.

Enable or disable a RPL item (policy group, rule, method, or goal).

Evaluate a set of expression slots.

Invoke a DMI or DMI group.

Execute the runs for the specified MRM configuration. The script dashboard displays the overall and/or individual run progress and status. For example, for a concurrent MRM, the dashboard shows the following:

For distributed MRM, the run status will be shown in the separate Distributed MRM Controller, not in the script dashboard.

Run the model using the currently selected controller.

The script dashboard displays the run progress and status. The following image shows the progress bar on the action row and a separate progress bar in the overall script status area. This is particularly useful in the Execute Run is part of a subscript or set of collapsed actions as it will always show the progress of the run.

Execute a script from within this script.

See Display of Execute Script and Sub-actions for more information on how sub-actions are displayed.

Export Database Data Management Interfaces (DMIs) to a file and optionally include name maps and datasets. See Export in Data Management Interface (DMI) for more information. Also, see Import Database DMI for information on the script action to import the Database DMI.

Export Objects to a file and optionally include links, object attributes, slot notes and accounting items. See Export in User Interface for more information on exporting objects. The options described in that section correspond to settings in this script action. Also, see Import Objects for information on the script action to import Objects from a file.

Export the specified optimization restore point to a file. For more information on optimization restore points, see Restore Point in Optimization and see Export a Restore Point in Optimization for details on exporting a restore point. Also see Import Optimization Restore Point for details to import a restore point from a file. The named restore point does not need to exist when the script action is configured, but it must exist when the script action is executed. Otherwise an error will be issued.

Export the selected table slot to a comma-separated values (CSV) file. The data will always be exported to the CSV file with display precision. The first column of the CSV file will be the row headers of the table slot. The first row of the CSV file will be the column headers of the table slot with units included in parentheses. Periodic table slots and statistical table slots can be exported to CSV files as well as standard table slots.

Generate the specified Output Device. This could be a file based device like a Model Report or a graphical device like a Plot Page.

Scroll time and series displays to the specified symbolic date/time.

Import Database Data Management Interfaces (DMIs) from a file and specify how to handle conflicts. See Import in Data Management Interface (DMI) for more information on the feature. See also Export Database DMI for information on the script action to export the Database DMI.

Import Objects from a file and specify how to import object attributes, slot notes and object clusters, and how to locate the imported objects. See Import in User Interface for more information on importing objects. The options described in that section correspond to the settings on this action. See also Export Objects for information on the script action to export Objects.

Import an optimization restore point from the specified file. For more information on optimization restore points, see Restore Point in Optimization and see Import a Restore Point in Optimization for details on importing a restore point. Also see Export Optimization Restore Point for details to export a restore point to a file.

Link the two specified slots. The slots must be physical slots (non-accounting) on two different objects. For more information on links, see Linking Slots on Objects in Getting Started Building a Model. It is not an error if the two slots are already linked. See also the complimentary action to Delete Link.

Open and load a goal set (for Optimization runs).

Open and load a ruleset (for Rulebased Simulation runs).

Pause script execution and optionally open a confirmation dialog with your user specified message. While script execution is paused, you can interact with RiverWare or other applications in ways not directly supported by scripts. Select the script Continue button to resume the script execution.

Open the Ensemble Data Tool and bring it to the top of the windows. For more information on this tool, see Ensemble Data Tool in Solution Approaches.

Open the specified external file using the windows file association. If you would like to pause script execution after opening the file, add a Memo action, described at Memo, after the Open File action.

Open a global function set.

Open the specified objects’ dialogs.

Open a System Control Table (SCT) with the specified filename.

Open the specified slots.

Remove a selected RPL set from the model. An RBS Ruleset or Optimization Goal set is unloaded and closed, a Global Function Set is closed, or the Initialization Rules Set is cleared.

Reorder the items (rules, goals, statements) in a RPL set according to priority or index defined on the specified table slot.

Replace the existing Initialization Rules Set from a file. Any changes made to the Initialization Rules in the model will be lost. Use with caution!

Save the model to a file.

Set the selected method in one of an account’s method categories.

Set the time range of the accounting system (i.e., the Begin Accounting Period and End Accounting Period dates).

Set the current controller.

Set the DSS file for a specified DSS Dataset or the Excel workbook for a specified Excel Dataset.

Set the evaluation time for the selected expression slots. For more information on evaluation time, see Evaluation Time in User Interface.

For the specified Database DMI Excel Dataset, set the run name type and/or specify a new single run name.

Set the Execute Initialization Rules run control flag. This flags controls whether or not the initialization rules are executed as part of the run. The flag is independent for each major controller, Simulation, Rulebased Simulation and Optimization. For more information, see Can I disable the Initialization Rules? in RiverWare Policy Language (RPL).

Set the selected method in the specified category for a set of objects.

In a given MRM configuration, set the specified keyword, value pair MRM Descriptor. The descriptors are shown on the Description tab of the MRM configuration. See Description in Solution Approaches for details.

In a given MRM configuration, set a new file path to a ruleset.The ruleset is shown on the Policy tab of the MRM configuration. See Policy in Solution Approaches for details.

Set the time range of the run (i.e. the Run Start and End dates) for the specified MRM configuration. The run range is shown on the Run Parameters tab of the MRM configuration. See Concurrent Runs in Solution Approaches for details.

Set the value of any optimization parameter that is either an integer or a real number.

When the Parameter Type is Enumeration, the text string specified for the value only needs to uniquely match the initial portion of one option. For example the LPMETHOD parameter has the following options

The Barrier method can be selected by typing the full name, Barrier, or by typing a shortened version such as Bar.

Set the value at the specified rows and columns on a set of periodic slots.

 

Set the time range of the run (i.e., the Run Start and End dates).

Set the run timestep size. This action is analogous to changing the run control timestep size. The settings in the action are analogous to the options presented in the Synchronize Timestep Change dialog; see Synchronize From Run Control in User Interface for details.

Set one or more Scalar Slot values.

Set the specified flag (input or output) on a set of series slots within the specified time range.

Set the input mode (series or periodic) for one or more Series Slots With Periodic Input. More information on these slots can be found in Series Slots With Periodic Input in User Interface.

For one or more Series Slots with Periodic Input, set a periodic value at a given row and column. If you’d like to instead set the series value, use Set Series Slot Values. More information on these slots can be found in Series Slots With Periodic Input in User Interface.

Set Series Slot values within a time range.

Set a value on a set of Table Slots at the specified rows and columns.

Specify a script variable and the default value; other actions can be dependent on the value of the variable. In the dashboard, the script operator can select the value from the valid values; dependent actions will then be executed or not based on their settings. For more information on using Script Variable Values for conditional execution of actions, see Script Variable Values and Dependencies.

 

 

 

 

 

Set the time range for the specified objects.

Set the time range an timestep size for the specified slots.

When the timestep specification is something different than the Run Timestep, symbolic datetime math for the Start Date and End Date settings (for example, Start Timestep - N Timesteps) is computed as follows. Start Timestep and Finish Timestep are the times for the Run Control Start Timestep and Finish Timestep at the time of the script action execution. The N Timesteps are the timestep size for the slot from the Timestep setting. Then the resulting datetime is rounded up to the nearest timestep based on the Timestep setting.

Visualize data for an ensemble data set. Currently, this action will create a plot of line curves:

The plot can be shown in the Ensemble Data Tool (EDT) and/or in a Plot Page. See Visualizing Data Sets in Solution Approaches for more information on interactive use of this action in the EDT.

For more information on Ensemble Data Sets, see Ensemble Data Tool in Solution Approaches.

For more information on a similar action to analyze the ensemble data set, see Analyze Ensemble Data Set.