GridViewer with provider

.github/workflows/subsurface.yml

@@ -10,142 +10,141 @@ on:
       - published
   schedule:
     # Run CI daily and check that tests are working with latest dependencies
-    - cron:  '0 0 * * *'
+    - cron: "0 0 * * *"
 
 jobs:
   webviz-subsurface:
     # Run on all events defined above, except pushes which are neither to master nor with a substring [deploy test] in commit message
     if: github.event_name != 'push' || github.ref == 'refs/heads/master' || contains(github.event.head_commit.message, '[deploy test]')
     runs-on: ubuntu-latest
     env:
-      PYTHONWARNINGS: default  # We want to see e.g. DeprecationWarnings
+      PYTHONWARNINGS: default # We want to see e.g. DeprecationWarnings
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
-
-    - name: 🧹 Remove unused pre-installed software
-      run: |
-        # https://github.com/actions/virtual-environments/issues/751
-        # https://github.com/actions/virtual-environments/issues/709
-        sudo apt-get purge p7zip* yarn ruby-full ghc* php7*
-        sudo apt-get autoremove
-        sudo apt-get clean
-        df -h
-
-    - name: 📖 Checkout commit locally
-      uses: actions/checkout@v2
-
-    - name: 🐍 Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: 📦 Install webviz-subsurface with dependencies
-      run: |
-        pip install --upgrade pip
-        if [[ $(pip freeze) ]]; then
-          pip freeze | grep -vw "pip" | xargs pip uninstall -y
-        fi
-        pip install "bleach<5"  # https://github.com/equinor/webviz-config/issues/586
-        pip install "werkzeug<2.1"  # ...while waiting for https://github.com/plotly/dash/issues/1992
-        pip install .
-
-        # Testing against our latest release (including pre-releases)
-        # Temporarily do not use prerelase of wsc due to https://github.com/equinor/webviz-subsurface-components/issues/1007
-        pip install --pre --upgrade webviz-config webviz-core-components # webviz-subsurface-components 
-
-    - name: 📦 Install test dependencies
-      run: |
-        pip install .[tests]
-        wget https://chromedriver.storage.googleapis.com/$(wget https://chromedriver.storage.googleapis.com/LATEST_RELEASE -q -O -)/chromedriver_linux64.zip
-        unzip chromedriver_linux64.zip
-        export PATH=$PATH:$PWD
-
-    - name: 🧾 List all installed packages
-      run: pip freeze
-
-    - name: 🕵️ Check code style & linting
-      run: |
-        black --check webviz_subsurface tests setup.py
-        pylint webviz_subsurface tests setup.py
-        bandit -r -c ./bandit.yml webviz_subsurface tests setup.py
-        isort --check-only webviz_subsurface tests setup.py
-        mypy --package webviz_subsurface
-
-    - name: 🤖 Run tests
-      env:
-        # If you want the CI to (temporarily) run against your fork of the testdada,
-        # change the value her from "equinor" to your username.
-        TESTDATA_REPO_OWNER: equinor
-        # If you want the CI to (temporarily) run against another branch than master,
-        # change the value her from "master" to the relevant branch name.
-        TESTDATA_REPO_BRANCH: master
-      run: |
-        git clone --depth 1 --branch $TESTDATA_REPO_BRANCH https://github.com/$TESTDATA_REPO_OWNER/webviz-subsurface-testdata.git
-        # Copy any clientside script to the test folder before running tests
-        mkdir ./tests/assets && cp ./webviz_subsurface/_assets/js/* ./tests/assets
-        pytest ./tests --headless --forked --testdata-folder ./webviz-subsurface-testdata
-        rm -rf ./tests/assets
-        webviz docs --portable ./docs_build --skip-open
-
-    - name: 🐳 Build Docker example image
-      if: matrix.python-version != '3.7'  # https://github.com/statsmodels/statsmodels/issues/8110
-      run: |
-        pip install --pre webviz-config-equinor
-        export SOURCE_URL_WEBVIZ_SUBSURFACE=https://github.com/$GITHUB_REPOSITORY
-        export GIT_POINTER_WEBVIZ_SUBSURFACE=$GITHUB_REF
-        webviz build ./webviz-subsurface-testdata/webviz_examples/webviz-full-demo.yml --portable ./example_subsurface_app --theme equinor
-        rm -rf ./webviz-subsurface-testdata
-        pushd example_subsurface_app
-        docker build -t webviz/example_subsurface_image:equinor-theme .
-        popd
-
-    - name: 🐳 Update Docker Hub example image
-      if: github.event_name != 'schedule' && github.ref == 'refs/heads/master' && matrix.python-version == '3.6'
-      run: |
-        echo ${{ secrets.dockerhub_webviz_token }} | docker login --username webviz --password-stdin
-        docker push webviz/example_subsurface_image:equinor-theme
-
-    - name: 🐳 Update review/test Docker example image
-      if: github.ref != 'refs/heads/master' && contains(github.event.head_commit.message, '[deploy test]') && matrix.python-version == '3.6'
-      run: |
-        docker tag webviz/example_subsurface_image:equinor-theme ${{ secrets.review_docker_registry_url }}/${{ secrets.review_container_name }}
-
-        echo ${{ secrets.review_docker_registry_token }} | docker login ${{ secrets.review_docker_registry_url }} --username ${{ secrets.review_docker_registry_username }} --password-stdin
-        docker push ${{ secrets.review_docker_registry_url }}/${{ secrets.review_container_name }}
-
-    - name: 🚢 Build and deploy Python package
-      if: github.event_name == 'release' && matrix.python-version == '3.6'
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.pypi_webviz_token }}
-      run: |
-        python -m pip install --upgrade setuptools wheel twine
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
-
-    - name: 📚 Update GitHub pages
-      if: github.event_name == 'release' && matrix.python-version == '3.6'
-      run: |
-        cp -R ./docs_build ../docs_build
-
-        git config --local user.email "webviz-github-action"
-        git config --local user.name "webviz-github-action"
-        git fetch origin gh-pages
-        git checkout --track origin/gh-pages
-        git clean -f -f -d -x
-        git rm -r *
-
-        cp -R ../docs_build/* .
-
-        git add .
-
-        if git diff-index --quiet HEAD; then
-          echo "No changes in documentation. Skip documentation deploy."
-        else
-          git commit -m "Update Github Pages"
-          git push "https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" gh-pages
-        fi
+      - name: 🧹 Remove unused pre-installed software
+        run: |
+          # https://github.com/actions/virtual-environments/issues/751
+          # https://github.com/actions/virtual-environments/issues/709
+          sudo apt-get purge p7zip* yarn ruby-full ghc* php7*
+          sudo apt-get autoremove
+          sudo apt-get clean
+          df -h
+
+      - name: 📖 Checkout commit locally
+        uses: actions/checkout@v2
+
+      - name: 🐍 Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: 📦 Install webviz-subsurface with dependencies
+        run: |
+          pip install --upgrade pip
+          if [[ $(pip freeze) ]]; then
+            pip freeze | grep -vw "pip" | xargs pip uninstall -y
+          fi
+          pip install "bleach<5"  # https://github.com/equinor/webviz-config/issues/586
+          pip install "werkzeug<2.1"  # ...while waiting for https://github.com/plotly/dash/issues/1992
+          pip install .
+
+          # Testing against our latest release (including pre-releases)
+          # Temporarily do not use prerelase of wsc due to https://github.com/equinor/webviz-subsurface-components/issues/1007
+          pip install --pre --upgrade webviz-config webviz-core-components # webviz-subsurface-components
+
+      - name: 📦 Install test dependencies
+        run: |
+          pip install .[tests]
+          wget https://chromedriver.storage.googleapis.com/$(wget https://chromedriver.storage.googleapis.com/LATEST_RELEASE -q -O -)/chromedriver_linux64.zip
+          unzip chromedriver_linux64.zip
+          export PATH=$PATH:$PWD
+
+      - name: 🧾 List all installed packages
+        run: pip freeze
+
+      - name: 🕵️ Check code style & linting
+        run: |
+          black --check webviz_subsurface tests setup.py
+          pylint webviz_subsurface tests setup.py
+          bandit -r -c ./bandit.yml webviz_subsurface tests setup.py
+          isort --check-only webviz_subsurface tests setup.py
+          mypy --package webviz_subsurface
+
+      - name: 🤖 Run tests
+        env:
+          # If you want the CI to (temporarily) run against your fork of the testdada,
+          # change the value her from "equinor" to your username.
+          TESTDATA_REPO_OWNER: hanskallekleiv
+          # If you want the CI to (temporarily) run against another branch than master,
+          # change the value her from "master" to the relevant branch name.
+          TESTDATA_REPO_BRANCH: more-grid
+        run: |
+          git clone --depth 1 --branch $TESTDATA_REPO_BRANCH https://github.com/$TESTDATA_REPO_OWNER/webviz-subsurface-testdata.git
+          # Copy any clientside script to the test folder before running tests
+          mkdir ./tests/assets && cp ./webviz_subsurface/_assets/js/* ./tests/assets
+          pytest ./tests --headless --forked --testdata-folder ./webviz-subsurface-testdata
+          rm -rf ./tests/assets
+          webviz docs --portable ./docs_build --skip-open
+
+      - name: 🐳 Build Docker example image
+        if: matrix.python-version != '3.7' # https://github.com/statsmodels/statsmodels/issues/8110
+        run: |
+          pip install --pre webviz-config-equinor
+          export SOURCE_URL_WEBVIZ_SUBSURFACE=https://github.com/$GITHUB_REPOSITORY
+          export GIT_POINTER_WEBVIZ_SUBSURFACE=$GITHUB_REF
+          webviz build ./webviz-subsurface-testdata/webviz_examples/webviz-full-demo.yml --portable ./example_subsurface_app --theme equinor
+          rm -rf ./webviz-subsurface-testdata
+          pushd example_subsurface_app
+          docker build -t webviz/example_subsurface_image:equinor-theme .
+          popd
+
+      - name: 🐳 Update Docker Hub example image
+        if: github.event_name != 'schedule' && github.ref == 'refs/heads/master' && matrix.python-version == '3.6'
+        run: |
+          echo ${{ secrets.dockerhub_webviz_token }} | docker login --username webviz --password-stdin
+          docker push webviz/example_subsurface_image:equinor-theme
+
+      - name: 🐳 Update review/test Docker example image
+        if: github.ref != 'refs/heads/master' && contains(github.event.head_commit.message, '[deploy test]') && matrix.python-version == '3.6'
+        run: |
+          docker tag webviz/example_subsurface_image:equinor-theme ${{ secrets.review_docker_registry_url }}/${{ secrets.review_container_name }}
+
+          echo ${{ secrets.review_docker_registry_token }} | docker login ${{ secrets.review_docker_registry_url }} --username ${{ secrets.review_docker_registry_username }} --password-stdin
+          docker push ${{ secrets.review_docker_registry_url }}/${{ secrets.review_container_name }}
+
+      - name: 🚢 Build and deploy Python package
+        if: github.event_name == 'release' && matrix.python-version == '3.6'
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.pypi_webviz_token }}
+        run: |
+          python -m pip install --upgrade setuptools wheel twine
+          python setup.py sdist bdist_wheel
+          twine upload dist/*
+
+      - name: 📚 Update GitHub pages
+        if: github.event_name == 'release' && matrix.python-version == '3.6'
+        run: |
+          cp -R ./docs_build ../docs_build
+
+          git config --local user.email "webviz-github-action"
+          git config --local user.name "webviz-github-action"
+          git fetch origin gh-pages
+          git checkout --track origin/gh-pages
+          git clean -f -f -d -x
+          git rm -r *
+
+          cp -R ../docs_build/* .
+
+          git add .
+
+          if git diff-index --quiet HEAD; then
+            echo "No changes in documentation. Skip documentation deploy."
+          else
+            git commit -m "Update Github Pages"
+            git push "https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" gh-pages
+          fi

setup.py

@@ -40,6 +40,8 @@
         "webviz_config_plugins": [
             "BhpQc = webviz_subsurface.plugins:BhpQc",
             "DiskUsage = webviz_subsurface.plugins:DiskUsage",
+            "EclipseGridViewer = webviz_subsurface.plugins:EclipseGridViewer",
+            "GridViewer = webviz_subsurface.plugins:GridViewer",
             "GroupTree = webviz_subsurface.plugins:GroupTree",
             "HistoryMatch = webviz_subsurface.plugins:HistoryMatch",
             "HorizonUncertaintyViewer = webviz_subsurface.plugins:HorizonUncertaintyViewer",
@@ -87,6 +89,7 @@
         "dash>=2.0.0",
         "dash_bootstrap_components>=0.10.3",
         "dash-daq>=0.5.0",
+        # "dash-vtk>=0.0.9",
         "dataclasses>=0.8; python_version<'3.7'",
         "defusedxml>=0.6.0",
         "ecl2df>=0.15.0; sys_platform=='linux'",
@@ -99,12 +102,16 @@
         "pillow>=6.1",
         "pyarrow>=5.0.0",
         "pyscal>=0.7.5",
+        "pyvista>=0.33.3",
         "scipy>=1.2",
         "statsmodels>=0.12.1",  # indirect dependency through https://plotly.com/python/linear-fits/
-        "webviz-config>=0.3.8",
-        "webviz-core-components>=0.5.6",
+        "vtk>=9.2.0rc2",
+        "webviz_config@git+https://github.com/equinor/webviz-config@50f0d20f5b6fd6c2d7ee98b17e229e625776ff82",
+        "webviz-core-components",
         "webviz-subsurface-components>=0.4.12",
-        "xtgeo>=2.14",
+        "webviz_vtk@git+https://github.com/equinor/webviz-vtk",
+        "xtgeo@git+https://github.com/sigurdp/xtgeo/@sigurdp/vtk-esg",
+        # "xtgeo>=2.18.0a1",
     ],
     extras_require={"tests": TESTS_REQUIRE},
     setup_requires=["setuptools_scm~=3.2"],

tests/unit_tests/plugin_tests/test_eclipse_grid_viewer/_utils.py

@@ -0,0 +1,36 @@
+# pylint: skip-file
+# type: ignore
+import numpy as np
+import pyvista as pv
+
+
+def create_explicit_structured_grid(
+    ni: int, nj: int, nk: int, si: float, sj: float, sk: float
+) -> pv.ExplicitStructuredGrid:
+
+    si = float(si)
+    sj = float(sj)
+    sk = float(sk)
+
+    # create raw coordinate grid
+    grid_ijk = np.mgrid[
+        : (ni + 1) * si : si, : (nj + 1) * sj : sj, : (nk + 1) * sk : sk
+    ]
+
+    # repeat array along each Cartesian axis for connectivity
+    for axis in range(1, 4):
+        grid_ijk = grid_ijk.repeat(2, axis=axis)
+
+    # slice off unnecessarily doubled edge coordinates
+    grid_ijk = grid_ijk[:, 1:-1, 1:-1, 1:-1]
+
+    # reorder and reshape to VTK order
+    corners = grid_ijk.transpose().reshape(-1, 3)
+
+    dims = np.array([ni, nj, nk]) + 1
+
+    grid = pv.ExplicitStructuredGrid(dims, corners)
+    grid = grid.compute_connectivity()
+    grid.ComputeFacesConnectivityFlagsArray()
+
+    return grid