Skip to main content

Webviz config plugins for subsurface data

Project description

PyPI version Build Status Total alerts Language grade: Python Python 3.6 | 3.7 | 3.8 | 3.9 Code style: black

Webviz subsurface

:sparkles::eyeglasses: Live demo application

Introduction

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

Installation

The easiest way of installing this package is to run

pip install webviz-subsurface

Add --upgrade if you have installed earlier, but want to upgrade to a newer version.

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

pip install git+https://github.com/equinor/webviz-subsurface

Usage and documentation

For general usage, see the documentation on webviz-config. End-user documentation for the subsurface containers are automatically built and hosted on the github pages for this repository.

There is also a live demo application 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.

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

Review of contributions

When doing review of contributions, it is usually useful to also see the resulting application live, and not only the code changes. In order to facilitate this, this repository is using GitHub actions.

When on a feature branch, and a commit message including the substring [deploy test] arrives, the GitHub action workflow will try to build and deploy a test Docker image for you (which you then can link to a web app with e.g. automatic reload on new images). All you need to do in your own fork is to add GitHub secrets with the following names:

  • review_docker_registry_url: The registry to push to (e.g. myregistry.azurecr.io)
  • review_docker_registry_username: Registry login username.
  • review_docker_registry_token: Registry login token (or password).
  • review_container_name: What you want to call the container pushed to the registry.

You are encouraged to rebase and squash/fixup unnecessary commits before pull request is merged to master.

Disclaimer

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webviz-subsurface-0.2.12rc0.tar.gz (560.6 kB view details)

Uploaded Source

Built Distribution

webviz_subsurface-0.2.12rc0-py3-none-any.whl (742.0 kB view details)

Uploaded Python 3

File details

Details for the file webviz-subsurface-0.2.12rc0.tar.gz.

File metadata

  • Download URL: webviz-subsurface-0.2.12rc0.tar.gz
  • Upload date:
  • Size: 560.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for webviz-subsurface-0.2.12rc0.tar.gz
Algorithm Hash digest
SHA256 33882e9f57b693dcaae990dc8e48f7d2efa4d8c0a9a77830ff5e2da4df0112cb
MD5 3feee98983b40e446f3b91c943052285
BLAKE2b-256 c5ac8bb28f06be61b8b6d6e8adb29bad60710559541b23e7481a162b0ebc1198

See more details on using hashes here.

File details

Details for the file webviz_subsurface-0.2.12rc0-py3-none-any.whl.

File metadata

  • Download URL: webviz_subsurface-0.2.12rc0-py3-none-any.whl
  • Upload date:
  • Size: 742.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for webviz_subsurface-0.2.12rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7e148d134712a29018b0ca9d900470e9541769baa29c54d790c58afe6fd8a55
MD5 ed940a152e10b9c9e8f07bbbc9d226d4
BLAKE2b-256 da04f090401aa1151e104e92e360d8f207106193e4cceb3ea14bdf089195f6b6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page