CO₂ migration plugin

[vegardkv]

Aimed at #993

Implements a new plugin for CO2 leakage analysis, using the new layout framework.

Example data is available via equinor/webviz-subsurface-testdata#136

(Known) remaining tasks:

• Code formatting

[vegardkv]

All comments should now have been addressed. There are some discussion points remaining, but I think they mostly relate to"big-picture" issues.

[vegardkv]

Fixed black and pylint reports. Came across an issue related to dependencies. This plugin implements a contour line generator which depends on matplotlib and shapely. I cannot see that these are used elsewhere. What is the policy for new dependencies?

There are some options here:

• Allow them (i.e. do nothing)
• Enable functionality based on package availability. If an ImportError occurs, this specific feature (contour lines) is disabled.
• Remove the functionality (for now). The implementation is experimental and not the most important. Its goal is to generate contour lines, but this can be left to the deck.gl component instead. It seems to have contour features, as well as Contour layer webviz-subsurface-components#622. However, I couldn't find a way to do make it work as I wanted.

[HansKallekleiv]

Fixed black and pylint reports. Came across an issue related to dependencies. This plugin implements a contour line generator which depends on matplotlib and shapely. I cannot see that these are used elsewhere. What is the policy for new dependencies?

There are some options here:

• Allow them (i.e. do nothing)
• Enable functionality based on package availability. If an ImportError occurs, this specific feature (contour lines) is disabled.
• Remove the functionality (for now). The implementation is experimental and not the most important. Its goal is to generate contour lines, but this can be left to the deck.gl component instead. It seems to have contour features, as well as Contour layer webviz-subsurface-components#622. However, I couldn't find a way to do make it work as I wanted.

For Equinor usage (komodo) I don't see this as a problem as both packages are already included.
@anders-kiaer , @asnyv any thoughts?

[asnyv]

Sorry, didn't see this until now.

We have tried before to avoid including unnecessary dependencies, and intentionally removed matplotlib as a dependency before due to size vs added value (see: #99). Of course not saying that we cannot add more dependencies, but think in a growing repo with several contributors, we should be a bit conservative. If the functionality is more or less experimental, at least I suggest you go for option 2 or 3 from your suggestions (so either try to import and disable if not available, or drop it). If it is found to be necessary later we can rather include the dependencies then.

[vegardkv]

Added a check for matplotlib + shapely availability. If an ImportError is raised, the functionality is effectively turned off. I think this is a reasonable solution for now, as this is not a critical part of the plugin. It is an experimental feature that we might want to improve upon later.

That being said, I suspect matplotlib and shapely are implicit dependencies of webviz_subsurface after all, probably via xtgeo? (I didn't really test properly until after the commit above). When I try to run this plugin, I get ImportError if matplotlib or shapely is not installed, originating from other parts of the code.

Since matplotlib/shapely is not explicit dependencies, I think the solution implemented in b7764aa should be fine

[HansKallekleiv]

Looks good to me 👍