This package will be deprecated - we move instead all collaboration focus to the reusable React and Dash components in:
- https://github.com/equinor/webviz-subsurface-components
- https://github.com/equinor/webviz-core-components
and the FMU use case to https://github.com/equinor/webviz
Webviz subsurface
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.
2 maintainers
Release files for webviz-subsurface 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| webviz_subsurface-0.3.0.tar.gz | 875.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| webviz_subsurface-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.9 MB
Release files / webviz_subsurface-0.3.0.tar.gz
| Download URL | webviz_subsurface-0.3.0.tar.gz |
|---|---|
| Size | 875.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
be997cec367080307b3e5432c91a15a3208f3bfec2dd6a7b413df528ace57ba2
|
|
BLAKE2b-256 checksum How to use checksums |
d7122819f1f6d11a126d1065c70c9266cb071c20978556f6aa83e35a5bcf285a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / webviz_subsurface-0.3.0-py3-none-any.whl
| Download URL | webviz_subsurface-0.3.0-py3-none-any.whl |
|---|---|
| Size | 996.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
60f83cfe49992951138041aa31b1ca42861393a65f395a972c666d767eb89b42
|
|
BLAKE2b-256 checksum How to use checksums |
8536435467b0fa8ebbfb9f7bbb46734201d1a09f40bb129bc806f43d3bc26d69
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
