Studies

Study Introduction

Studies combine a stream process with scenarios, methodologies, and reports to
be run as a whole.

A methodology is a collection of frameworks. A framework is a collection of models.

Studies can be built through the UI.

Building Studies

1. Navigate to the Build Study tab.
2. Create a new study by clicking the icon in the Study Configuration panel
   to the left.
3. Enter a Study Name and a Study Description on the upper part of the Build
   Study screen.
4. Select a Stream from the list in the Select Stream tab of the Build Study
   screen.
5. View the subprocesses, nodes, and queues of the selected stream by clicking
   the icon to the right of the stream.
6. Deselect using the date in the Results name by unchecking the box in the
   Select Stream tab.
7. Move to the Select Options tab by clicking the Next button on the lower right.
8. Select an As of Date for the Study by clicking the icon.
9. If only a part is desired, select the Percent of the input data to process
   by moving the slider to the left.
10. Select the Output Currency from the drop-down menu in the Select Options tab.
11. Select to Save the Results of the study by clicking the box in the Select
    Options tab.
12. Select Email Notification to receive an email when the study run completes.
13. Move to the Select Methodology tab by clicking the Next button on the lower right.

14. Select a Methodology by clicking the box to the left of the relevant one.

    Note

    Including a methodology is optional. Only one methodology can be included in a study.

15. Move to the Select Options tab by clicking the Next button on the lower right.

16. Select Scenarios to include in the study by clicking the box to the left of the scenario name.

    Note

    Including scenarios is optional. If only one scenario is selected it is given the weight of 100%. If multiple scenarios are selected, they are applied individually and weighted together.

17. Enter the weight of each to the right of the scenario.

18. Move to the Done tab by clicking the Next button on the lower right.

    Info

    The Done tab shows a summary of the study configuration.

19. Save the study by clicking the icon on the upper right of the screen. Enter a Comment for the study save in the pop-up screen. Then click the Save button.

    The study now appears in the list in the Study Configuration panel to the left.

Running Studies

1. Navigate to the Run Studies tab.

2. Select a study to run from the Available Studies list by clicking the box
   to the left of the Study Name.

   Success

   Now the Study Configuration shows in the panel to the right.

3. Move to the Options tab by clicking on Options on top of the Available Studies list.

4. Enable debugging by moving the slider right.

5. Enable logging by moving the slider right.

   Info

   Sipping means monitoring a small number of observations in a queue during processing to make sure the data looks as expected.

6. Enable sipping by moving the slider right. Select one or more queues to sip
   from by clicking the :fontawesome_solid_gear: icon next to slider, then click the node viewer's icon, and click the boxes next to the relevant queues. Then save the selections by clicking the Save button on the upper right.

7. Move to the Data tab by clicking on Data on top of the Available Studies list.

   Info

   The Data tab allows for adding uploaded data that has not already been included in the study, such as portfolio data or overlays. The Data tab cannot be used to include or override macroeconomic scenarios.

8. Select an Upload Type from the drop-down menu to filter the list of available uploaded data.

9. Select uploaded data to include in the study run by clicking the box to the
   right of the uploaded file name.

10. Move to the Filters tab by clicking on Filters on top of the Available Studies list.

    Info

    The Filters tab allows for sub-setting portfolio data with filters that have already been defined in the general Filters tab. While there are many types of filters, only portfolio filters are applicable to a study run.

11. Select Filters to apply by clicking the box to the left of the Filter Name. Multiple filters can be applied to the portfolio. The filters will be applied in the order they were selected.

12. Move to the Reports tab by clicking on Reports on top of the Available Studies list.

13. Select Reports to run with the Study by clicking the box to the left of the Report Name. Multiple reports can be included in the study run.

    All the Selected Options appear on the panel to the right.

14. Once done with study run configuration, run the study by clicking the icon in the upper right corner.

15. Enter a name for the results folder and a comment for study run. Then
    click the "Run It" button in the lower right corner.

    Once the study runs, the Process viewer appears.

Viewing Study Runs

1. Navigate to the Waterways tab.

   Info

   In the Waterways tab, the study runs are organized by the stream processes they include.

2. Expand the relevant stream process by clicking the icon to the left of the Stream Name.

   Info

   Stream processes currently running are favored in the expanded list. These are marked with a Run icon in the Status field.

3. Toggle between running and ended stream processes by sliding the Running Streams to the upper right of a stream run history list to the left or right.

4. Search a stream run history list by entering a search word in the Search box in the upper right corner.
5. View the subprocesses, nodes, and queues of a running stream process by clicking the icon to the right of the relevant study run.
6. Within the process viewer, view statistics for a subprocess or node by
   clicking the icon on the right side of the subprocess or node.
7. Within the process viewer, view the log for a subprocess or node by clicking the :material-document: icon on the right side of the subprocess or node.
8. Within the process viewer, view the input and output queues for a subprocess or node by clicking the icon on the right side of the subprocess or node.
9. Within the process viewer, if a running stream process has subprocesses, view the nodes of the subprocess by clicking the icon on the right side of the subprocess.
10. Within the process viewer, return to the Waterways screen by clicking Waterways in the upper left corner.

11. Cancel a running study by clicking the icon to the right of the study run.

    Info

    Once a study run has completed, the status of the completion is shown in the Status field. A study run can end with the following status:

    • Finished
    • Finished with warnings
    • Finished with errors
    • Canceled
    • Failed to compile

12. View the logs for a study run by clicking the Status icon in the Status field.

13. Mark a study run finished without errors or warnings as the golden copy by
    clicking the icon to the right of the study run.
14. Download scenarios and other included data from a study run by clicking the icon to the right of the study run.