Metadata-Version: 2.1
Name: webviz-subsurface
Version: 0.0.21
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/manual/webviz/webviz-subsurface?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=equinor/webviz-subsurface&amp;utm_campaign=Badge_Grade)
        [![Python 3.6 | 3.7](https://img.shields.io/badge/python-3.6%20|%203.7-blue.svg)](https://www.python.org/)
        ![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)
        
        ## 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
        
        
        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.
        
        There is also a [live demo application](https://webviz-subsurface-example.azurewebsites.net)
        showing how a created application can look like, using the `master` branch of this repository.
        
        ### Example webviz configuration files
        
        Example `webviz` configuration files, and corresponding test data, is available at
        https://github.com/equinor/webviz-subsurface-testdata.
        
        See that repository for instructions on how to download and run the examples.
        
        ### 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).
        
        You can do automatic linting of your code changes by running
        ```bash
        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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Environment :: Web Environment
Classifier: Framework :: Dash
Classifier: Framework :: Flask
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
Provides-Extra: tests
