Support lazy loading of individual plugins (#1183)

equinor · Dec 11, 2022 · d3dc886 · d3dc886
1 parent c017009
commit d3dc886
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 95 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [UNRELEASED] - YYYY-MM-DD
 
 ### Changed
+- [#1183](https://github.com/equinor/webviz-subsurface/pull/1183) - Reduced loading time by lazy loading only requested plugins when application starts.
 - [#1182](https://github.com/equinor/webviz-subsurface/pull/1182) - `ParameterResponseCorrelation` can now allow default None column_keys when using arrow file as input
 - [#1122](https://github.com/equinor/webviz-subsurface/pull/1122) - `opm` and `ecl2df` are now optional, making `windows-subsurface` possible to install and import on non-unix based systems. **NOTE:** a lot of the functionality in `webviz-subsurface` is built on `opm` and `ecl2df`, and issues are therefore expected on eg Windows and macOS. Use with care.
 - [#1146](https://github.com/equinor/webviz-subsurface/pull/1146) - Converted the `BhpQc` plugin to WLF (Webviz Layout Framework).

diff --git a/setup.py b/setup.py
@@ -37,51 +37,51 @@
     },
     entry_points={
         "webviz_config_plugins": [
-            "BhpQc = webviz_subsurface.plugins:BhpQc",
-            "CO2Leakage = webviz_subsurface.plugins:CO2Leakage",
-            "DiskUsage = webviz_subsurface.plugins:DiskUsage",
-            "EXPERIMENTALGridViewerFMU = webviz_subsurface.plugins:EXPERIMENTALGridViewerFMU",
-            "GroupTree = webviz_subsurface.plugins:GroupTree",
-            "HistoryMatch = webviz_subsurface.plugins:HistoryMatch",
-            "HorizonUncertaintyViewer = webviz_subsurface.plugins:HorizonUncertaintyViewer",
-            "InplaceVolumes = webviz_subsurface.plugins:InplaceVolumes",
-            "InplaceVolumesOneByOne = webviz_subsurface.plugins:InplaceVolumesOneByOne",
-            "LinePlotterFMU = webviz_subsurface.plugins:LinePlotterFMU",
-            "MapViewerFMU = webviz_subsurface.plugins:MapViewerFMU",
-            "MorrisPlot = webviz_subsurface.plugins:MorrisPlot",
-            "ParameterAnalysis = webviz_subsurface.plugins:ParameterAnalysis",
-            "ParameterCorrelation = webviz_subsurface.plugins:ParameterCorrelation",
-            "ParameterDistribution = webviz_subsurface.plugins:ParameterDistribution",
-            "ParameterParallelCoordinates = webviz_subsurface.plugins:ParameterParallelCoordinates",
-            "ParameterResponseCorrelation = webviz_subsurface.plugins:ParameterResponseCorrelation",
-            "ProdMisfit = webviz_subsurface.plugins:ProdMisfit",
-            "PropertyStatistics = webviz_subsurface.plugins:PropertyStatistics",
-            "PvtPlot = webviz_subsurface.plugins:PvtPlot",
-            "RelativePermeability = webviz_subsurface.plugins:RelativePermeability",
-            "ReservoirSimulationTimeSeries = webviz_subsurface.plugins:ReservoirSimulationTimeSeries",
-            "ReservoirSimulationTimeSeriesOneByOne = webviz_subsurface.plugins:ReservoirSimulationTimeSeriesOneByOne",
-            "ReservoirSimulationTimeSeriesRegional = webviz_subsurface.plugins:ReservoirSimulationTimeSeriesRegional",
-            "RftPlotter = webviz_subsurface.plugins:RftPlotter",
-            "RunningTimeAnalysisFMU = webviz_subsurface.plugins:RunningTimeAnalysisFMU",
-            "SegyViewer = webviz_subsurface.plugins:SegyViewer",
-            "SimulationTimeSeries = webviz_subsurface.plugins:SimulationTimeSeries",
-            "SeismicMisfit = webviz_subsurface.plugins:SeismicMisfit",
-            "StructuralUncertainty = webviz_subsurface.plugins:StructuralUncertainty",
-            "SubsurfaceMap = webviz_subsurface.plugins:SubsurfaceMap",
-            "SurfaceViewerFMU = webviz_subsurface.plugins:SurfaceViewerFMU",
-            "SurfaceWithGridCrossSection = webviz_subsurface.plugins:SurfaceWithGridCrossSection",
-            "SurfaceWithSeismicCrossSection = webviz_subsurface.plugins:SurfaceWithSeismicCrossSection",
-            "SwatinitQC = webviz_subsurface.plugins:SwatinitQC",
-            "TornadoPlotterFMU = webviz_subsurface.plugins:TornadoPlotterFMU",
-            "VfpAnalysis = webviz_subsurface.plugins:VfpAnalysis",
-            "VolumetricAnalysis = webviz_subsurface.plugins:VolumetricAnalysis",
-            "WellCrossSection = webviz_subsurface.plugins:WellCrossSection",
-            "WellCrossSectionFMU = webviz_subsurface.plugins:WellCrossSectionFMU",
-            "AssistedHistoryMatchingAnalysis = webviz_subsurface.plugins:AssistedHistoryMatchingAnalysis",
-            "WellCompletions = webviz_subsurface.plugins:WellCompletions",
-            "WellCompletion = webviz_subsurface.plugins:WellCompletion",
-            "WellLogViewer = webviz_subsurface.plugins:WellLogViewer",
-            "WellAnalysis = webviz_subsurface.plugins:WellAnalysis",
+            "AssistedHistoryMatchingAnalysis = webviz_subsurface.plugins._assisted_history_matching_analysis:AssistedHistoryMatchingAnalysis",
+            "BhpQc = webviz_subsurface.plugins._bhp_qc:BhpQc",
+            "CO2Leakage = webviz_subsurface.plugins._co2_leakage:CO2Leakage",
+            "DiskUsage = webviz_subsurface.plugins._disk_usage:DiskUsage",
+            "EXPERIMENTALGridViewerFMU = webviz_subsurface.plugins._grid_viewer_fmu:EXPERIMENTALGridViewerFMU",
+            "GroupTree = webviz_subsurface.plugins._group_tree:GroupTree",
+            "HistoryMatch = webviz_subsurface.plugins._history_match:HistoryMatch",
+            "HorizonUncertaintyViewer = webviz_subsurface.plugins._horizon_uncertainty_viewer:HorizonUncertaintyViewer",
+            "InplaceVolumes = webviz_subsurface.plugins._inplace_volumes:InplaceVolumes",
+            "InplaceVolumesOneByOne = webviz_subsurface.plugins._inplace_volumes_onebyone:InplaceVolumesOneByOne",
+            "LinePlotterFMU = webviz_subsurface.plugins._line_plotter_fmu.line_plotter_fmu:LinePlotterFMU",
+            "MapViewerFMU = webviz_subsurface.plugins._map_viewer_fmu:MapViewerFMU",
+            "MorrisPlot = webviz_subsurface.plugins._morris_plot:MorrisPlot",
+            "ParameterAnalysis = webviz_subsurface.plugins._parameter_analysis:ParameterAnalysis",
+            "ParameterCorrelation = webviz_subsurface.plugins._parameter_correlation:ParameterCorrelation",
+            "ParameterDistribution = webviz_subsurface.plugins._parameter_distribution:ParameterDistribution",
+            "ParameterParallelCoordinates = webviz_subsurface.plugins._parameter_parallel_coordinates:ParameterParallelCoordinates",
+            "ParameterResponseCorrelation = webviz_subsurface.plugins._parameter_response_correlation:ParameterResponseCorrelation",
+            "ProdMisfit = webviz_subsurface.plugins._prod_misfit:ProdMisfit",
+            "PropertyStatistics = webviz_subsurface.plugins._property_statistics:PropertyStatistics",
+            "PvtPlot = webviz_subsurface.plugins._pvt_plot:PvtPlot",
+            "RelativePermeability = webviz_subsurface.plugins._relative_permeability:RelativePermeability",
+            "ReservoirSimulationTimeSeries = webviz_subsurface.plugins._reservoir_simulation_timeseries:ReservoirSimulationTimeSeries",
+            "ReservoirSimulationTimeSeriesOneByOne = webviz_subsurface.plugins._reservoir_simulation_timeseries_onebyone:ReservoirSimulationTimeSeriesOneByOne",
+            "ReservoirSimulationTimeSeriesRegional = webviz_subsurface.plugins._reservoir_simulation_timeseries_regional:ReservoirSimulationTimeSeriesRegional",
+            "RftPlotter = webviz_subsurface.plugins._rft_plotter:RftPlotter",
+            "RunningTimeAnalysisFMU = webviz_subsurface.plugins._running_time_analysis_fmu:RunningTimeAnalysisFMU",
+            "SegyViewer = webviz_subsurface.plugins._segy_viewer:SegyViewer",
+            "SeismicMisfit = webviz_subsurface.plugins._seismic_misfit:SeismicMisfit",
+            "SimulationTimeSeries = webviz_subsurface.plugins._simulation_time_series:SimulationTimeSeries",
+            "StructuralUncertainty = webviz_subsurface.plugins._structural_uncertainty:StructuralUncertainty",
+            "SubsurfaceMap = webviz_subsurface.plugins._subsurface_map:SubsurfaceMap",
+            "SurfaceViewerFMU = webviz_subsurface.plugins._surface_viewer_fmu:SurfaceViewerFMU",
+            "SurfaceWithGridCrossSection = webviz_subsurface.plugins._surface_with_grid_cross_section:SurfaceWithGridCrossSection",
+            "SurfaceWithSeismicCrossSection = webviz_subsurface.plugins._surface_with_seismic_cross_section :SurfaceWithSeismicCrossSection",
+            "SwatinitQC = webviz_subsurface.plugins._swatinit_qc:SwatinitQC",
+            "TornadoPlotterFMU = webviz_subsurface.plugins._tornado_plotter_fmu:TornadoPlotterFMU",
+            "VfpAnalysis = webviz_subsurface.plugins._vfp_analysis:VfpAnalysis",
+            "VolumetricAnalysis = webviz_subsurface.plugins._volumetric_analysis:VolumetricAnalysis",
+            "WellAnalysis = webviz_subsurface.plugins._well_analysis:WellAnalysis",
+            "WellCompletion = webviz_subsurface.plugins._well_completion:WellCompletion",
+            "WellCompletions = webviz_subsurface.plugins._well_completions:WellCompletions",
+            "WellCrossSection = webviz_subsurface.plugins._well_cross_section:WellCrossSection",
+            "WellCrossSectionFMU = webviz_subsurface.plugins._well_cross_section_fmu:WellCrossSectionFMU",
+            "WellLogViewer = webviz_subsurface.plugins._well_log_viewer:WellLogViewer",
         ],
         "console_scripts": ["smry2arrow_batch=webviz_subsurface.smry2arrow_batch:main"],
     },

diff --git a/webviz_subsurface/plugins/__init__.py b/webviz_subsurface/plugins/__init__.py
@@ -19,53 +19,3 @@
           - iter-1
 ```
 """
-
-from ._assisted_history_matching_analysis import AssistedHistoryMatchingAnalysis
-from ._bhp_qc import BhpQc
-from ._co2_leakage import CO2Leakage
-from ._disk_usage import DiskUsage
-from ._grid_viewer_fmu import EXPERIMENTALGridViewerFMU
-from ._group_tree import GroupTree
-from ._history_match import HistoryMatch
-from ._horizon_uncertainty_viewer import HorizonUncertaintyViewer
-from ._inplace_volumes import InplaceVolumes
-from ._inplace_volumes_onebyone import InplaceVolumesOneByOne
-from ._line_plotter_fmu.line_plotter_fmu import LinePlotterFMU
-from ._map_viewer_fmu import MapViewerFMU
-from ._morris_plot import MorrisPlot
-from ._parameter_analysis import ParameterAnalysis
-from ._parameter_correlation import ParameterCorrelation
-from ._parameter_distribution import ParameterDistribution
-from ._parameter_parallel_coordinates import ParameterParallelCoordinates
-from ._parameter_response_correlation import ParameterResponseCorrelation
-from ._prod_misfit import ProdMisfit
-from ._property_statistics import PropertyStatistics
-from ._pvt_plot import PvtPlot
-from ._relative_permeability import RelativePermeability
-from ._reservoir_simulation_timeseries import ReservoirSimulationTimeSeries
-from ._reservoir_simulation_timeseries_onebyone import (
-    ReservoirSimulationTimeSeriesOneByOne,
-)
-from ._reservoir_simulation_timeseries_regional import (
-    ReservoirSimulationTimeSeriesRegional,
-)
-from ._rft_plotter import RftPlotter
-from ._running_time_analysis_fmu import RunningTimeAnalysisFMU
-from ._segy_viewer import SegyViewer
-from ._seismic_misfit import SeismicMisfit
-from ._simulation_time_series import SimulationTimeSeries
-from ._structural_uncertainty import StructuralUncertainty
-from ._subsurface_map import SubsurfaceMap
-from ._surface_viewer_fmu import SurfaceViewerFMU
-from ._surface_with_grid_cross_section import SurfaceWithGridCrossSection
-from ._surface_with_seismic_cross_section import SurfaceWithSeismicCrossSection
-from ._swatinit_qc import SwatinitQC
-from ._tornado_plotter_fmu import TornadoPlotterFMU
-from ._vfp_analysis import VfpAnalysis
-from ._volumetric_analysis import VolumetricAnalysis
-from ._well_analysis import WellAnalysis
-from ._well_completion import WellCompletion
-from ._well_completions import WellCompletions
-from ._well_cross_section import WellCrossSection
-from ._well_cross_section_fmu import WellCrossSectionFMU
-from ._well_log_viewer import WellLogViewer