Merge Everest into ert

.github/workflows/build_and_test.yml

@@ -125,7 +125,7 @@ jobs:
 
     - name: Install ert
       run: |
-        uv pip install ".[dev]"
+        uv pip install ".[dev, everest]"
 
     - name: Make test directory
       run: |
@@ -136,7 +136,7 @@ jobs:
 
     - name: Test docs
       run: |
-        sphinx-build -n -v -E -W ./docs ./tmp/ert_docs
+        sphinx-build -n -v -E -W ./docs/ert ./tmp/ert_docs
 
   publish:
     name: Publish to PyPI

.github/workflows/test_ert.yml

@@ -40,7 +40,7 @@ jobs:
 
     - name: Install ert
       run: |
-        uv pip install ".[dev]"
+        uv pip install ".[dev, everest]"
 
     - name: GUI Test
       if: inputs.test-type == 'gui-tests'
@@ -56,7 +56,7 @@ jobs:
       if: inputs.test-type == 'unit-tests'
       run: |
         pytest --cov=ert --cov-report=xml:cov1.xml --junit-xml=junit.xml -n logical --show-capture=stderr -v --benchmark-disable --dist loadgroup tests/unit_tests
-        pytest --doctest-modules --cov=ert --cov-report=xml:cov2.xml src/ --ignore src/ert/dark_storage
+        pytest --doctest-modules --cov=ert --cov-report=xml:cov2.xml src/ --ignore src/ert/dark_storage --ignore src/ieverest
 
     - name: Performance Test
       if: inputs.test-type == 'performance-tests'

.github/workflows/test_everest.yml

@@ -1,57 +1,76 @@
-name: Test everest
+name: everest-run-tests-build-docs
 
-# This job checks whether current main of everest
-# is compatible with the changes. It is not required to pass
-# before merging, but breakage should be followed by fix in everest
-# after merge.
-
-on: [pull_request]
-
-env:
-  UV_SYSTEM_PYTHON: 1
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    tags: "*"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
+env:
+  NO_PROJECT_RES: 1
+
 jobs:
-  test-everest:
-    name: Test everest
-    timeout-minutes: 40
-    runs-on: ubuntu-latest
+  tests:
+    name: "py_${{ matrix.python-version }}_${{ matrix.test_type }}"
+    timeout-minutes: 60
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.12']
+        python-version: ['3.8', '3.11', '3.12']
+        os: [ubuntu-22.04]
+        test_type: ['doc', 'ui-test', 'test', 'integration-test', 'everest-models-test']
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-
-    - name: Set up Python
+    - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        cache: "pip"
 
-    - name: Install uv
-      run: pip install uv
+    - name: Install Everest and dependencies
+      run: |
+        pip install ".[dev,everest]"
 
-    - name: Install ert
+    - name: Run Tests
+      if: matrix.test_type == 'test'
       run: |
-        uv pip install .
+        pytest tests/everest -n 4 -m "not ui_test and not integration_test" --dist loadgroup -sv
 
-    - name: Install everest and dependencies
+    - name: Run Integration Tests
+      if: matrix.test_type == 'integration-test'
       run: |
-        git clone https://github.com/equinor/everest.git
-        uv pip install git+https://github.com/equinor/everest-models.git
+        pytest tests -n 4 -m "integration_test" --dist loadgroup
 
-    - name: Test everest
+    - name: Run UI Tests
+      if: matrix.test_type == 'ui-test'
       env:
         QT_QPA_PLATFORM: 'minimal'
-        NO_PROJECT_RES: 1
       run: |
-        pushd everest
-        uv pip install ".[test]"
+        python -m pytest tests/everest -m "ui_test"
+
+    - name: Build Documentation
+      if: matrix.test_type == 'doc'
+      run: |
+        pip install git+https://github.com/equinor/everest-models.git
+        mkdir tmp
+        sphinx-build -n -v -E -W ./docs/everest ./tmp/everest_docs
 
-        pytest tests -n 4 --dist loadgroup -m "not ui_test"
-        pytest tests -m "ui_test"
+    - name: Run tests requiring everest-models
+      if: matrix.test_type == 'everest-models-test'
+      run: |
+        pip install git+https://github.com/equinor/everest-models.git
+        python -m pytest tests -n 4 -m everest_models_test --dist loadgroup
+
+    - name: Test docs entry point
+      if: matrix.test_type == 'everest-docs-entry-test'
+      run: |
+        python -m everest.docs

.github/workflows/test_everest_macos.yml

@@ -0,0 +1,79 @@
+name: everest-macos-run-tests-build-docs
+
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    tags: "*"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+env:
+  NO_PROJECT_RES: 1
+
+jobs:
+  tests:
+    if: github.ref_type == 'tag' # only build for mac when tags
+    name: "py-${{ matrix.python-version }}_${{ matrix.test_type }}_${{ matrix.os }}"
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.8', '3.12']
+        os: ['macos-13', 'macos-14', 'macos-14-large']
+        # https://github.com/actions/runner-images/tree/main?tab=readme-ov-file#available-images
+        exclude:
+          - os: 'macos-14'
+            python-version: '3.8'
+          - os: 'macos-14-large'
+            python-version: '3.8'
+          - os: 'macos-13'
+            python-version: '3.12'
+
+        test_type: ['doc', 'test', 'integration-test', 'everest-models-test']
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: "pip"
+        cache-dependency-path: |
+          pyproject.toml
+
+    - name: Install HDF5 source files
+      run: brew install hdf5
+
+    - name: Install Everest and dependencies
+      run: |
+        pip install .[dev, everest]
+
+    - name: Run Tests
+      if: matrix.test_type == 'test'
+      run: |
+        python -m pytest tests/everest -n 4 -m "not ui_test and not integration_test and not fails_on_macos_github_workflow" --dist loadgroup
+
+    - name: Run Integration Tests
+      if: matrix.test_type == 'integration-test'
+      run: |
+        python -m pytest tests/everest -n 4 -m "integration_test and not fails_on_macos_github_workflow" --dist loadgroup
+
+    - name: Build Documentation
+      if: matrix.test_type == 'doc'
+      run: |
+        pip install git+https://github.com/equinor/everest-models.git
+        mkdir tmp
+        sphinx-build -n -v -E -W ./docs/everest ./tmp/everest_docs
+
+    - name: Run tests requiring everest-models
+      if: matrix.test_type == 'everest-models-test'
+      run: |
+        pip install git+https://github.com/equinor/everest-models.git
+        python -m pytest tests/everest -n 4 -m everest_models_test --dist loadgroup

.github/workflows/typing.yml

@@ -37,9 +37,13 @@ jobs:
 
     - name: Install ERT and dependencies
       run: |
-        uv pip install ".[dev, types]"
+        uv pip install ".[dev, types, everest]"
 
     - run: echo ::add-matcher::.github/mypy-matcher.json
-    - name: Run mypy
+    - name: Run mypy ert
       run: |
         mypy src/ert
+
+    - name: Run mypy everest
+      run: |
+        mypy src/everest

.mypy.ini

@@ -40,3 +40,42 @@ ignore_missing_imports = True
 
 [mypy-seaborn.*]
 ignore_missing_imports = True
+
+[mypy-opm.*]
+ignore_missing_imports = True
+
+[mypy-colorama.*]
+ignore_missing_imports = True
+
+[mypy-ruamel.*]
+ignore_missing_imports = True
+
+[mypy-resdata.*]
+ignore_missing_imports = True
+disable_error_code = import-untyped
+
+[mypy-everest.*]
+disable_error_code = dict-item,
+                     no-untyped-def,
+                     call-overload,
+                     union-attr,
+                     no-untyped-call,
+                     var-annotated,
+                     index,
+                     call-arg,
+                     unused-ignore,
+                     arg-type,
+                     type-arg,
+                     type-var,
+                     assignment,
+                     typeddict-item,
+                     attr-defined,
+                     comparison-overlap,
+                     return-value,
+                     name-defined
+
+[mypy-tests.*]
+disable_error_code = no-untyped-def, no-untyped-call, typeddict-item, assignment
+
+[mypy-ieverest.*]
+ignore_errors = True

.pre-commit-config.yaml

@@ -5,6 +5,7 @@ repos:
     -   id: no-commit-to-branch
     -   id: check-json
     -   id: check-yaml
+        exclude: tests/everest/test_data/valid_config_file/invalid_yaml_config.yml # Invalid yml needed for testing
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
         exclude: test-data/eclipse/parse/ERROR.PRT # exact format is needed for testing

README.md

@@ -32,6 +32,18 @@ $ ert --help
 
 For examples and help with configuration, see the [ert Documentation](https://ert.readthedocs.io/en/latest/getting_started/configuration/poly_new/guide.html#configuration-guide).
 
+# Everest™
+
+The primary goal of the Everest tool is to find *optimal* well
+planning and production strategies by utilizing an ensemble of
+reservoir models (e.g., an ensemble of geologically-consistent models).
+This will enable robust decisions about drilling schedule and well
+placement, in order to achieve results of significant practical value.
+
+```bash
+    pip install . "[everest]"
+```
+
 ## Developing
 
 To start developing the Python code, we suggest installing ert in editable mode
@@ -49,7 +61,7 @@ pip install --upgrade pip wheel setuptools
 # Download and install ert
 git clone https://github.com/equinor/ert
 cd ert
-pip install --editable ".[dev]"
+pip install --editable ".[dev, everest]"
 ```
 
 ### Test setup
@@ -93,7 +105,7 @@ git submodule foreach "git lfs pull"
 You can build the documentation after installation by running
 ```bash
 pip install ".[dev]"
-sphinx-build -n -v -E -W ./docs ./tmp/ert_docs
+sphinx-build -n -v -E -W ./docs/ert ./tmp/ert_docs
 ```
 and then open the generated `./tmp/ert_docs/index.html` in a browser.
 

docs/conf.py → docs/ert/conf.py

@@ -16,7 +16,7 @@
 import sys
 from importlib import metadata
 
-sys.path.append(os.path.abspath("./_ext"))
+sys.path.append(os.path.abspath("_ext"))
 
 # -- Project information -----------------------------------------------------
 

docs/getting_started/howto/plugin_system.rst → docs/ert/getting_started/howto/plugin_system.rst

@@ -129,7 +129,7 @@ The configuration file needed to use the ``installable_workflow_jobs`` hook must
 and specify its arguments.
 The built-in internal ``CSV_EXPORT`` workflow job is shown as an example:
 
-.. literalinclude:: ../../../src/ert/resources/workflows/jobs/internal-gui/config/CSV_EXPORT
+.. literalinclude:: ../../../../src/ert/resources/workflows/jobs/internal-gui/config/CSV_EXPORT
 
 Implement the hook specification as follows to register the workflow job ``CSV_EXPORT``:
 
@@ -150,7 +150,7 @@ Implement the hook specification as follows to register the workflow job ``CSV_E
 The second approach does not require creating a workflow job configuration file up-front,
 and allows adding documentation.
 
-.. literalinclude:: ../../../src/ert/plugins/hook_specifications/jobs.py
+.. literalinclude:: ../../../../src/ert/plugins/hook_specifications/jobs.py
    :pyobject: legacy_ertscript_workflow
 
 Minimal example:

docs/index.rst → docs/ert/index.rst

@@ -1,4 +1,4 @@
-.. image:: ../src/ert/gui/resources/gui/img/ert_icon.svg
+.. image:: ../../src/ert/gui/resources/gui/img/ert_icon.svg
    :align: center
    :scale: 50%