Restructure ReservoirSimulationTimeSeries

[anders-kiaer]

The current plugin has "been with us" since the start, and has been extended by different people during the project period. Time to consolidate/restructure/improve the code.

Related issues:

• ReservoirSimulationTimeSeries can take in list of vectors instead of vector{1,2,3} as user input #677
• New functionality in the Simulation-time-series plugin #630
• User request: Multiple deltas in same plot in ReservoirSimulationTimeseries #502
• Fan charts assume mean between p10 and p90 #488
• Metadata support when using aggregated time series data #402
• Annotate simulation time series #335
• Eclipse UDQs #321
• Feature request - simulation time series #214

Functionality for calculating new custom vectors, delta between ensembles etc. should be in separate modules (as other plugins will need the same calculation options).

[anders-kiaer]

Quick summary from meeting between @asnyv, @jorgenherje and myself going through the linked issues above:

• Create a common utility to create fan chart input to plotly dcc.Graph.

  • Make mean independent of the shades (but keep in same legend group).

• Try to fetch user selected date range in plotly graph and use it when changing to new vector.

• Create UI (and later support it in the plugin) for showing multiple ensembles (with varying A and B).

  • @jorgenherje to make some UI sketches before implementing.

• Support user defined vector annotations as input to plugin.

  • E.g. user defined descriptions of user defined UDQ.
  • E.g. user defined annotations ([{vector, datetime, label}]).

• Stacking possibility (i.e. show time series in same plot)

  • across ensembles enforces same vector
  • if multiple vectors enforces same ensemble.

• Statistics + individual realizations in same plot.

• Secondary axis (and/or third axis?)

  • Automatically decide if same axis or different axis based on "same unit and not order of magnitude difference in max/min).

Related factory responsibility (@sigurdp):

• Support metadata through .csv (in addition to .arrow and from .UNSMRY). We can define how that metadata should come together with the .csv.

[jorgenherje]

Above mentioned summary as checklist (for @jorgenherje):

• Create a common utility to create fan chart input to plotly dcc.Graph.

  • Make mean independent of the shades (but keep in same legend group).
  • Common fan chart input utility #719

• Try to fetch user selected date range in plotly graph and use it when changing to new vector.

  • Selected date rage is interpreted as storing x-axis zoom. Thereby "uirevision" is investigated for storing the UI state (zoom level etc.) of a Graph when updating the Graph in a callback.
  • "uirevision" is already handled in PR: Preserve uirevision in timeseries and relperm plugins #717

• Create UI (and later support it in the plugin) for showing multiple ensembles (with varying A and B).

  • @jorgenherje to make some UI sketches before implementing.
  • Create delta ensemble as new ensemble? Preventing separate mode for delta ensemble
    • PR: New simulation time series plugin #867
  • Create delta relative to date within ensemble
    • PR: Delta relative to date within ensemble SimulationTimeSeries #951

• Support user defined vector annotations as input to plugin.

  • E.g. user defined descriptions of user defined UDQ.
    • PR: User defined vector definition in SimulationTimeSeries plugin #940
    • Note: Made user defined vector definitions - allowing to config both description and type of any vector name
  • E.g. user defined annotations ([{vector, datetime, label}]).
    • New issue: Add user defined vector annotations in SimulationTimeSeries #942
    • On ice until answer from plotly on issue: Hover & text on shapes plotly/plotly.js#4780

• Stacking possibility (i.e. show time series in same plot)

  • PR: New simulation time series plugin #867
  • across ensembles enforces same vector
    • Note: current solution
  • if multiple vectors enforces same ensemble.
    • Note: same ensemble for all subplots, or individual ensemble selection per subplot? One VectorSelector per subplot?
    • Answer: from Asgeir: Opposite of existing, i.e. subplot per ensemble and place all vectors from VectorSelector in each subplot. Legend per vector and not per ensemble.
  • Note:
    • New "mode"?
    • One VectorSelector per plot/subgraph?
    • How many vectors can be selected?
  • Solution:
    • Subplot per ensemble, with single VectorSelector

• Statistics + individual realizations in same plot.

  • PR: New SimulationTimeSeries Plugin: Statistics + realizations plot #883
  • Add possibility to plot statistics and selected realizations in same plot.
  • How:
    • Make Visualization options as checkboxes or add additional Visualization radio item for statistics+real
    • Selection of realizations:
      • Look to Volumetricplugin, which has range and selector

• Secondary axis (and/or third axis?)

  • New issue: Secondary y-axis for subplots SimulationTimeSeries plugin #954
  • Automatically decide if same axis or different axis based on "same unit and not order of magnitude difference in max/min).
  • Should this be a general utility for plot/graphing?
  • https://plotly.com/python/multiple-axes/

Related factory responsibility (@sigurdp):

• Support metadata through .csv (in addition to .arrow and from .UNSMRY). We can define how that metadata should come together with the .csv.

[jorgenherje]

Refactoring done.

Two bullet points has gotten new issues:

• Secondary y-axis for subplots SimulationTimeSeries plugin #954
• Add user defined vector annotations in SimulationTimeSeries #942