webviz-subsurface 0.2.40__py3-none-any.whl → 0.2.42__py3-none-any.whl

webviz_subsurface/_providers/ensemble_surface_provider/surface_array_server.py

@@ -3,16 +3,15 @@ import io
 import json
 import logging
 import math
+import tempfile
 from dataclasses import asdict, dataclass
 from typing import List, Optional, Tuple, Union
 from urllib.parse import quote
-from uuid import uuid4
 
 import flask
 import flask_caching
 import xtgeo
 from dash import Dash
-from webviz_config.webviz_instance_info import WEBVIZ_INSTANCE_INFO
 
 from webviz_subsurface._utils.perf_timer import PerfTimer
 
@@ -51,10 +50,7 @@ class SurfaceArrayMeta:
 
 class SurfaceArrayServer:
     def __init__(self, app: Dash) -> None:
-        cache_dir = (
-            WEBVIZ_INSTANCE_INFO.storage_folder
-            / f"SurfaceArrayServer_filecache_{uuid4()}"
-        )
+        cache_dir = tempfile.mkdtemp()
         LOGGER.debug(f"Setting up file cache in: {cache_dir}")
         self._array_cache = flask_caching.Cache(
             config={

webviz_subsurface/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.40'
-__version_tuple__ = version_tuple = (0, 2, 40)
+__version__ = version = '0.2.42'
+__version_tuple__ = version_tuple = (0, 2, 42)
 
 __commit_id__ = commit_id = None

webviz_subsurface/plugins/_co2_migration/__init__.py

@@ -0,0 +1 @@
+from ._plugin import CO2Migration

webviz_subsurface/plugins/{_co2_leakage → _co2_migration}/_plugin.py

@@ -1,4 +1,5 @@
 import logging
+from datetime import datetime
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import plotly.graph_objects as go
@@ -7,14 +8,15 @@ from dash.exceptions import PreventUpdate
 from webviz_config import WebvizPluginABC, WebvizSettings
 from webviz_config.utils import StrEnum, callback_typecheck
 
-from webviz_subsurface._providers import FaultPolygonsServer, SurfaceImageServer
+from webviz_subsurface._providers import FaultPolygonsServer, SurfaceArrayServer
 from webviz_subsurface._providers.ensemble_polygon_provider import PolygonServer
-from webviz_subsurface.plugins._co2_leakage._utilities.callbacks import (
+from webviz_subsurface.plugins._co2_migration._utilities.callbacks import (
     SurfaceData,
     create_map_annotations,
     create_map_layers,
     create_map_viewports,
     derive_surface_address,
+    export_figure_data_to_csv,
     extract_legendonly,
     generate_containment_figures,
     generate_unsmry_figures,
@@ -27,10 +29,10 @@ from webviz_subsurface.plugins._co2_leakage._utilities.callbacks import (
     readable_name,
     set_plot_ids,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.fault_polygons_handler import (
+from webviz_subsurface.plugins._co2_migration._utilities.fault_polygons_handler import (
     FaultPolygonsHandler,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.generic import (
+from webviz_subsurface.plugins._co2_migration._utilities.generic import (
     BoundarySettings,
     Co2MassScale,
     Co2VolumeScale,
@@ -39,8 +41,9 @@ from webviz_subsurface.plugins._co2_leakage._utilities.generic import (
     MapThresholds,
     MapType,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.initialization import (
+from webviz_subsurface.plugins._co2_migration._utilities.initialization import (
     init_containment_data_providers,
+    init_dates_per_ensemble,
     init_dictionary_of_content,
     init_map_attribute_names,
     init_menu_options,
@@ -50,24 +53,26 @@ from webviz_subsurface.plugins._co2_leakage._utilities.initialization import (
     init_unsmry_data_providers,
     init_well_pick_provider,
 )
-from webviz_subsurface.plugins._co2_leakage.views.mainview.mainview import (
+from webviz_subsurface.plugins._co2_migration.views.mainview.mainview import (
     MainView,
     MapViewElement,
 )
-from webviz_subsurface.plugins._co2_leakage.views.mainview.settings import ViewSettings
+from webviz_subsurface.plugins._co2_migration.views.mainview.settings import (
+    ViewSettings,
+)
 
 from . import _error
 from ._types import LegendData
-from ._utilities.color_tables import co2leakage_color_tables
-from ._utilities.containment_info import StatisticsTabOption
+from ._utilities.color_tables import co2migration_color_tables
+from ._utilities.containment_info import MainTabOption, StatisticsTabOption
 
 LOGGER = logging.getLogger(__name__)
 TABLES_PATH = "share/results/tables"
 
 
 # pylint: disable=too-many-instance-attributes
-class CO2Leakage(WebvizPluginABC):
-    """Plugin for analyzing CO2 leakage potential across multiple realizations in an
+class CO2Migration(WebvizPluginABC):
+    """Plugin for analyzing CO2 migration across multiple realizations in an
     FMU ensemble
 
     ---
@@ -121,7 +126,7 @@ class CO2Leakage(WebvizPluginABC):
 
     The following keys are allowed: `MIGRATION_TIME_SGAS, MIGRATION_TIME_AMFG,
     MIGRATION_TIME_XMF2, MAX_SGAS, MAX_AMFG, MAX_XMF2, MAX_SGSTRAND, MAX_SGTRH, MASS,
-    DISSOLVED, FREE, FREE_GAS, TRAPPED_GAS`
+    DISSOLVED_WATER, DISSOLVED_OIL, FREE, FREE_GAS, TRAPPED_GAS`
 
     Well pick files and fault polygons might name surfaces differently than the ones
     generated by the ccs-scripts workflow. The options
@@ -184,7 +189,7 @@ class CO2Leakage(WebvizPluginABC):
                 for ensemble_name in ensembles
             }
             self._realizations_per_ensemble = init_realizations(ensemble_paths)
-            self._surface_server = SurfaceImageServer.instance(app)
+            self._surface_server = SurfaceArrayServer.instance(app)
             self._polygons_server = FaultPolygonsServer.instance(app)
             self._map_attribute_names = init_map_attribute_names(
                 webviz_settings, ensembles, map_attribute_names
@@ -195,6 +200,10 @@ class CO2Leakage(WebvizPluginABC):
             self._ensemble_surface_providers = init_surface_providers(
                 webviz_settings, ensembles
             )
+            # Dates
+            self._ensemble_dates = init_dates_per_ensemble(
+                ensembles, self._map_attribute_names, self._ensemble_surface_providers
+            )
             # Polygons
             self._fault_polygon_handlers = {
                 ens: FaultPolygonsHandler(
@@ -251,7 +260,7 @@ class CO2Leakage(WebvizPluginABC):
             "change": False,
             "unit": "tons",
         }
-        self._color_tables = co2leakage_color_tables()
+        self._color_tables = co2migration_color_tables()
         self._well_pick_names: Dict[str, List[str]] = {
             ens: (
                 self._well_pick_provider[ens].well_names
@@ -296,30 +305,6 @@ class CO2Leakage(WebvizPluginABC):
             .to_string()
         )
 
-    def _ensemble_dates(self, ens: str) -> List[str]:
-        surface_provider = self._ensemble_surface_providers[ens]
-        date_map_attribute = next(
-            (
-                k
-                for k in self._map_attribute_names.filtered_values
-                if MapType[k.name].value != "MIGRATION_TIME"
-            ),
-            None,
-        )
-        att_name = (
-            self._map_attribute_names[date_map_attribute]
-            if date_map_attribute is not None
-            else None
-        )
-        dates = (
-            None
-            if att_name is None
-            else surface_provider.surface_dates_for_attribute(att_name)
-        )
-        if dates is None:
-            raise ValueError(f"Failed to fetch dates for attribute '{att_name}'")
-        return dates
-
     # Might want to do some refactoring if this gets too big
     def _set_callbacks(self) -> None:
         if self._content["any_table"]:
@@ -327,6 +312,7 @@ class CO2Leakage(WebvizPluginABC):
             self._add_legend_change_callback()
             self._add_set_unit_list_callback()
             self._add_time_plot_visibility_callback()
+            self._add_csv_export_callback()
 
         if self._content["maps"]:
             self._add_set_dates_callback()
@@ -515,17 +501,17 @@ class CO2Leakage(WebvizPluginABC):
                 current_thresholds,
                 mass_unit,
                 self._visualization_info,
-                self._surface_server._image_cache,
+                self._surface_server._array_cache,
             )
             if self._visualization_info["change"]:
                 return [], None, no_update
             attribute = MapAttribute(attribute)
             if len(realization) == 0 or ensemble is None:
                 raise PreventUpdate
-            if isinstance(date, int):
-                datestr = self._ensemble_dates(ensemble)[date]
-            elif date is None:
+            if MapType[MapAttribute(attribute).name].value == "MIGRATION_TIME":
                 datestr = None
+            else:
+                datestr = self._ensemble_dates[ensemble][date]
             # Contour data
             contour_data = None
             if MapType[MapAttribute(attribute).name].value == "PLUME":
@@ -657,13 +643,12 @@ class CO2Leakage(WebvizPluginABC):
             if ensemble is None:
                 return {}, None
             # Dates
-            date_list = self._ensemble_dates(ensemble)
             dates = {
                 i: {
                     "label": f"{d[:4]}",
                     "style": {"writingMode": "vertical-rl"},
                 }
-                for i, d in enumerate(date_list)
+                for i, d in enumerate(self._ensemble_dates[ensemble])
             }
             if len(dates.keys()) > 0:
                 return dates, max(dates.keys())
@@ -741,6 +726,7 @@ class CO2Leakage(WebvizPluginABC):
             Input(self._settings_component(ViewSettings.Ids.BOX_SHOW_POINTS), "value"),
         )
         @callback_typecheck
+        # pylint: disable=too-many-locals
         def update_graphs(
             legend_data: LegendData,
             ensemble: str,
@@ -763,8 +749,10 @@ class CO2Leakage(WebvizPluginABC):
             date_option: str,
             statistics_tab_option: StatisticsTabOption,
             box_show_points: str,
-        ) -> Tuple[Dict, go.Figure, go.Figure, go.Figure]:
-            # pylint: disable=too-many-locals
+        ) -> Tuple[go.Figure, go.Figure, go.Figure]:
+            if len(realizations) == 0:
+                return go.Figure(), go.Figure(), go.Figure()
+
             figs = [no_update] * 3
             cont_info = process_containment_info(
                 zone,
@@ -892,3 +880,55 @@ class CO2Leakage(WebvizPluginABC):
         if event is None or not isinstance(event, list):
             return False
         return any("visible" in e for e in event if isinstance(e, dict))
+
+    def _add_csv_export_callback(self) -> None:
+        @callback(
+            Output(self._view_component(MapViewElement.Ids.DOWNLOAD_CSV), "data"),
+            Input(
+                self._view_component(MapViewElement.Ids.CSV_EXPORT_BUTTON), "n_clicks"
+            ),
+            State(self._view_component(MapViewElement.Ids.SUMMARY_TABS), "value"),
+            State(self._view_component(MapViewElement.Ids.BAR_PLOT), "figure"),
+            State(self._view_component(MapViewElement.Ids.TIME_PLOT), "figure"),
+            State(self._view_component(MapViewElement.Ids.STATISTICS_PLOT), "figure"),
+            State(
+                self._settings_component(ViewSettings.Ids.STATISTICS_TAB_OPTION),
+                "value",
+            ),
+            prevent_initial_call=True,
+        )
+        def export_data(
+            _n_clicks: int,
+            active_tab: str,
+            bar_figure: go.Figure,
+            time_figure: go.Figure,
+            stats_figure: go.Figure,
+            statistics_tab_option: StatisticsTabOption,
+        ) -> Dict[str, Any]:
+            file_name = "co2_migration"
+            if active_tab == MainTabOption.CONTAINMENT_STATE:
+                current_figure = bar_figure
+                file_name += "_state_plot"
+                plot_choice = "containment_state"
+            elif active_tab == MainTabOption.CONTAINMENT_OVER_TIME:
+                current_figure = time_figure
+                file_name += "_time_plot"
+                plot_choice = "containment_time"
+            elif active_tab == MainTabOption.STATISTICS:
+                current_figure = stats_figure
+                if statistics_tab_option == StatisticsTabOption.PROBABILITY_PLOT:
+                    file_name += "_prob_plot"
+                    plot_choice = "probability"
+                else:  # => StatisticsTabOption.BOX_PLOT:
+                    file_name += "_box_plot"
+                    plot_choice = "box"
+            else:
+                raise PreventUpdate  # Should not happen
+
+            date_and_time = datetime.now().strftime("%y%m%d_%H%M%S")
+            file_name += f"_{date_and_time}.csv"
+            result = export_figure_data_to_csv(current_figure, file_name, plot_choice)
+
+            if result is None:
+                raise PreventUpdate
+            return result

webviz_subsurface/plugins/{_co2_leakage → _co2_migration}/_utilities/callbacks.py

@@ -1,3 +1,4 @@
+import logging
 import warnings
 from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Tuple, Union
@@ -6,7 +7,7 @@ import geojson
 import numpy as np
 import plotly.graph_objects as go
 import webviz_subsurface_components as wsc
-from dash import no_update
+from dash import dcc, no_update
 from flask_caching import Cache
 
 from webviz_subsurface._providers import (
@@ -14,32 +15,33 @@ from webviz_subsurface._providers import (
     SimulatedSurfaceAddress,
     StatisticalSurfaceAddress,
     SurfaceAddress,
-    SurfaceImageMeta,
-    SurfaceImageServer,
+    SurfaceArrayMeta,
+    SurfaceArrayServer,
 )
 from webviz_subsurface._providers.ensemble_surface_provider.ensemble_surface_provider import (
     SurfaceStatistic,
 )
-from webviz_subsurface.plugins._co2_leakage._types import LegendData
-from webviz_subsurface.plugins._co2_leakage._utilities import plume_extent
-from webviz_subsurface.plugins._co2_leakage._utilities.co2volume import (
+from webviz_subsurface.plugins._co2_migration._types import LegendData
+from webviz_subsurface.plugins._co2_migration._utilities import plume_extent
+from webviz_subsurface.plugins._co2_migration._utilities.co2volume import (
+    extract_df_from_fig,
     generate_co2_box_plot_figure,
     generate_co2_statistics_figure,
     generate_co2_time_containment_figure,
     generate_co2_time_containment_one_realization_figure,
     generate_co2_volume_figure,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.containment_data_provider import (
+from webviz_subsurface.plugins._co2_migration._utilities.containment_data_provider import (
     ContainmentDataProvider,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.containment_info import (
+from webviz_subsurface.plugins._co2_migration._utilities.containment_info import (
     ContainmentInfo,
     StatisticsTabOption,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.ensemble_well_picks import (
+from webviz_subsurface.plugins._co2_migration._utilities.ensemble_well_picks import (
     EnsembleWellPicks,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.generic import (
+from webviz_subsurface.plugins._co2_migration._utilities.generic import (
     Co2MassScale,
     Co2VolumeScale,
     FilteredMapAttribute,
@@ -50,17 +52,19 @@ from webviz_subsurface.plugins._co2_leakage._utilities.generic import (
     MapType,
     MenuOptions,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.summary_graphs import (
+from webviz_subsurface.plugins._co2_migration._utilities.summary_graphs import (
     generate_summary_figure,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.surface_publishing import (
+from webviz_subsurface.plugins._co2_migration._utilities.surface_publishing import (
     TruncatedSurfaceAddress,
     publish_and_get_surface_metadata,
 )
-from webviz_subsurface.plugins._co2_leakage._utilities.unsmry_data_provider import (
+from webviz_subsurface.plugins._co2_migration._utilities.unsmry_data_provider import (
     UnsmryDataProvider,
 )
 
+LOGGER = logging.getLogger(__name__)
+
 
 def property_origin(
     attribute: MapAttribute, map_attribute_names: FilteredMapAttribute
@@ -81,12 +85,12 @@ class SurfaceData:
     color_map_range: Tuple[Optional[float], Optional[float]]
     color_map_name: str
     value_range: Tuple[float, float]
-    meta_data: SurfaceImageMeta
+    meta_data: SurfaceArrayMeta
     img_url: str
 
     @staticmethod
     def from_server(
-        server: SurfaceImageServer,
+        server: SurfaceArrayServer,
         provider: EnsembleSurfaceProvider,
         address: Union[SurfaceAddress, TruncatedSurfaceAddress],
         color_map_range: Tuple[Optional[float], Optional[float]],
@@ -158,11 +162,6 @@ def derive_surface_address(
             threshold=contour_data["threshold"] if contour_data else 0.0,
             smoothing=contour_data["smoothing"] if contour_data else 0.0,
         )
-    date = (
-        None
-        if MapType[MapAttribute(attribute).name].value == "MIGRATION_TIME"
-        else date
-    )
     if len(realization) == 1:
         return SimulatedSurfaceAddress(
             attribute=map_attribute_names[attribute],
@@ -192,7 +191,7 @@ def get_plume_polygon(
     surface_provider: EnsembleSurfaceProvider,
     realizations: List[int],
     surface_name: str,
-    datestr: str,
+    datestr: Optional[str],
     contour_data: Dict[str, Any],
 ) -> Optional[geojson.FeatureCollection]:
     surface_attribute = contour_data["property"]
@@ -312,17 +311,22 @@ def create_map_layers(
     layers = []
     if surface_data is not None:
         # Update ColormapLayer
+        meta = surface_data.meta_data
         layers.append(
             {
-                "@@type": "ColormapLayer",
-                "name": surface_data.readable_name,
+                "@@type": "MapLayer",
                 "id": "colormap-layer",
-                "image": surface_data.img_url,
-                "bounds": surface_data.meta_data.deckgl_bounds,
-                "valueRange": surface_data.value_range,
-                "colorMapRange": surface_data.color_map_range,
+                "name": surface_data.readable_name,
+                "meshUrl": surface_data.img_url,
+                "frame": {
+                    "origin": [meta.x_ori, meta.y_ori],
+                    "count": [meta.x_count, meta.y_count],
+                    "increment": [meta.x_inc, meta.y_inc],
+                    "rotDeg": meta.rot_deg,
+                },
                 "colorMapName": surface_data.color_map_name,
-                "rotDeg": surface_data.meta_data.deckgl_rot_deg,
+                "colorMapRange": surface_data.color_map_range,
+                "material": False,
             }
         )
 
@@ -408,7 +412,7 @@ def generate_containment_figures(
     try:
         fig0 = generate_co2_volume_figure(
             table_provider,
-            table_provider.realizations,
+            realizations,
             co2_scale,
             containment_info,
             legenddata["bar_legendonly"],
@@ -624,7 +628,7 @@ def set_plot_ids(
 def process_summed_mass(
     formation: str,
     realization: List[int],
-    datestr: str,
+    datestr: Optional[str],
     attribute: MapAttribute,
     summed_mass: Optional[float],
     surf_data: Optional[SurfaceData],
@@ -641,3 +645,22 @@ def process_summed_mass(
                     f" ({unit}) (Total: {summed_co2[summed_co2_key]:.2E}): "
                 )
     return surf_data, summed_co2
+
+
+def export_figure_data_to_csv(
+    figure: Dict, file_name: str, plot_choice: str
+) -> Optional[Dict[str, Any]]:
+    """Export visible figure data to CSV file"""
+    try:
+        figure_go = go.Figure(figure)  # Dash State returns dict
+        df = extract_df_from_fig(figure_go.data, plot_choice)
+        if df.empty:
+            LOGGER.warning("No plot data to export to CSV file.")
+            return None
+
+        result = dcc.send_data_frame(df.to_csv, filename=file_name, index=False)
+        return result
+
+    except (ValueError, KeyError, AttributeError, TypeError) as e:
+        LOGGER.warning(f"Failed to export plot data to CSV file: {e}")
+        return None