Webviz subsurface configuration

Introduction

This repository contains subsurface specific standard webviz containers, which are used as plugins in webviz-config.

Installation

As Dash is using Python3-only functionality, you should create a Python3 virtual environment before installation. One way of doing this is

PATH_TO_VENV='./my_new_venv'
python3 -m virtualenv $PATH_TO_VENV
source $PATH_TO_VENV/bin/activate

The easiest way of installing this package is to run

pip install webviz-subsurface

If you want to install the latest code you can instead run

git clone [email protected]:Equinor/webviz-subsurface.git
cd webviz-subsurface
pip install .

Usage and documentation

For general usage, see the documentation on webviz-config. Take a look at this configuration example for something subsurface specific.

End-user documentation for the subsurface containers are automatically built and hosted on the github pages for this repository.

Creating new elements

If you are interested in creating new elements which can be configured through the configuration file, take a look at the webviz-config contribution guide.

You can do automatic linting of your code changes by running

black --check webviz_subsurface tests # Check code style
pylint webviz_subsurface tests # Check code quality
bandit -r -c ./bandit.yml webviz_subsurface tests  # Check Python security best practice

Disclaimer

This is a tool under heavy development. The current configuration file layout, also for subsurface pages, will therefore see large changes.