Metadata-Version: 2.1
Name: webviz-subsurface
Version: 0.0.8
Summary: Webviz config containers for subsurface data
Home-page: https://github.com/equinor/webviz-subsurface
Author: R&T Equinor
License: UNKNOWN
Description: [![PyPI version](https://badge.fury.io/py/webviz-subsurface.svg)](https://badge.fury.io/py/webviz-subsurface)
        [![Build Status](https://travis-ci.org/equinor/webviz-subsurface.svg?branch=master)](https://travis-ci.org/equinor/webviz-subsurface)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/9fd7a8b451754841a1eb6600c08be967)](https://www.codacy.com/app/anders-kiaer/webviz-subsurface?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=equinor/webviz-subsurface&amp;utm_campaign=Badge_Grade)
        [![Python 3.6+](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/)
        
        ## Webviz subsurface configuration 
        
        ### Introduction
        
        This repository contains subsurface specific standard `webviz` containers, which are used as
        plugins in [webviz-config](https://github.com/equinor/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
        ```bash
        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
        ```bash
        pip install webviz-subsurface
        ```
        
        If you want to install the latest code you can instead run
        ```bash
        git clone git@github.com:Equinor/webviz-subsurface.git
        cd webviz-subsurface
        pip install .
        ```
        
        ### Usage and documentation
        
        For general usage, see the documentation on
        [webviz-config](https://github.com/equinor/webviz-config). Take a look at
        [this configuration example](./examples/basic_example.yaml)
        for something subsurface specific.
        
        End-user documentation for the subsurface containers are automatically built
        and hosted on the [github pages](https://equinor.github.io/webviz-subsurface/)
        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](https://github.com/equinor/webviz-config/blob/master/CONTRIBUTING.md).
        
        ### Disclaimer
        
        This is a tool under heavy development. The current configuration file layout,
        also for subsurface pages, will therefore see large changes.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: tests
