Documentation egg model

docs/brugge_model_example.rst

@@ -0,0 +1,5 @@
+==========================
+Brugge model case
+==========================
+
+

docs/egg_model_example.rst

@@ -0,0 +1,145 @@
+==========================
+The Egg model case
+==========================
+
+
+The Egg model  is a synthetic reservoir model developed by `J. D. Jansen et al., 2013 <https://rmets.onlinelibrary.wiley.com/doi/pdf/10.1002/gdj3.21>`_ [1].
+
+
+Data files
+==========
+
+- `The Egg Model - data files  <https://data.4tu.nl/articles/The_Egg_Model_-_data_files/12707642>`_ [2]
+
+
+Modifications to the simulations setup
+======================================
+
+A few modifications to the original Egg model input file `Egg_Model_ECL.DATA` are required in order run Flownet.
+
+1. The COMPAT section is changed to have differences in depth between injectors and producers. With this, we avoid problems related to degenerate tetrahedrons that we would otherwise obtain in the triangulation procedure for the network generation.
+
+::
+
+        COMPDAT
+            'INJECT1'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /                    
+            'INJECT2'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /            
+            'INJECT3'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /
+            'INJECT4'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /
+            'INJECT5'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /
+            'INJECT6'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /
+            'INJECT7'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /
+            'INJECT8'    2*    4     7 'OPEN' 2*     0.2 	1*          0 /
+            'PROD1'      2*    1     3 'OPEN' 2*     0.2 	1*          0 / 
+            'PROD2'      2*    1     3 'OPEN' 2*     0.2 	1*          0 / 
+            'PROD3'      2*    1     3 'OPEN' 2*     0.2 	1*          0 / 
+            'PROD4'      2*    1     3 'OPEN' 2*     0.2	1*          0 /
+        /
+
+
+
+2. The section PROPS simulation keyword is saved as an independent file `PROPS.inc`.  
+
+::
+
+            DENSITY
+                900 1000          1 /
+            PVCDO
+                400          1 1.000E-05        5        0/
+            PVTW
+                400          1 1.000E-05        1        0/
+
+
+3. Output variables of interest have been specified in the SUMMARY section.
+
+::
+
+        SUMMARY
+            FOPR
+            FWPR
+            FWIR
+            WOPR
+            'PROD1'
+            'PROD2'
+            'PROD3'
+            'PROD4'
+            /
+            WWPR
+            'PROD1'
+            'PROD2'
+            'PROD3'
+            'PROD4'
+            /
+            WWIR
+            'INJECT1' 
+            'INJECT2'
+            'INJECT3' 
+            'INJECT4' 
+            'INJECT5'
+            'INJECT6'
+            'INJECT7'
+            'INJECT8'
+            /   
+            FOPT
+            FWPT
+            FWIT
+            WLPR
+            'PROD1'
+            'PROD2'
+            'PROD3'
+            'PROD4'
+            /
+            WBHPH
+            /
+            WBHP
+            /
+
+
+4. Then you can run - `OPM Flow <https://opm-project.org/?page_id=19>`_ to update input files to FlowNet
+
+.. code-block:: bash
+
+    flow Egg_Model_ECL.DATA
+
+
+
+
+
+Assisted history matching example
+=================================
+
+The following  `YAML <https://yaml.org/>`_ configuration file for FlowNet was used to train the data-driven version of the Egg model:
+
+.. literalinclude:: ../examples/egg_parameters.yml
+   :language: yaml
+   :linenos:
+
+
+To run the assisted history matching in FlowNet:
+
+
+.. code-block:: bash
+
+   flowet ahm /config_file_directory/egg_parameters.yml  output_directory
+
+
+
+Webiz visualization
+===================
+
+.. code-block:: bash
+
+    python output_directory/generated_app/webviz_app.py
+
+
+.. image:: ./_static/webviz_results_egg_model.png
+
+
+References
+==========
+
+[1] Jansen, J.D., Fonseca, R.M., Kahrobaei, S., Siraj, M.M., Van Essen, G.M., and Van den Hof, P.M.J.,        2014: The egg model - A geological ensemble for reservoir simulation. Geoscience Data Journal 1 (2) 192-195. https://doi.org/10.1002/gdj3.21    
+
+
+[2] J.D. Jansen (2013): The Egg Model - data files. 4TU.ResearchData. Dataset.
+    https://doi.org/10.4121/uuid:916c86cd-3558-4672-829a-105c62985ab2

docs/examples.rst

@@ -0,0 +1,9 @@
+**************************
+Examples
+**************************
+
+.. include:: norne_model_example.rst
+
+.. include:: brugge_model_example.rst
+
+.. include:: egg_model_example.rst

docs/index.rst

@@ -9,6 +9,7 @@ FlowNet documentation
 
    introduction
    configuration_file
+   examples
    api
 
 Indices and tables

docs/introduction.rst

@@ -80,7 +80,7 @@ The core developers of FlowNet are currently testing on the following open bench
 
  - `Norne model <https://github.com/OPM/opm-data/tree/master/norne>`_
  - `Brugge model <https://www.isapp2.com/data-sharepoint/brugge-data-set.html>`_ (soon to be available on GitHub)
- - `Egg model <https://data.4tu.nl/repository/uuid:916c86cd-3558-4672-829a-105c62985ab2>`_
+ - `Egg model <https://data.4tu.nl/articles/The_Egg_Model_-_data_files/12707642>`_
 
 A small Norne assisted history matching example using FlowNet is automatically started
 on each commit to FlowNet pull requests, in order verify the code changes.

docs/norne_model_example.rst

@@ -0,0 +1,5 @@
+==========================
+Norne model case
+==========================
+
+

examples/egg_parameters.yml

@@ -0,0 +1,78 @@
+name: Egg
+
+flownet:
+  data_source:
+    input_case: ../input_model/EGG_MODEL_ECL
+  cell_length: 10
+  additional_flow_nodes: 50
+  additional_node_candidates: 1000
+  hull_factor: 1.2
+  random_seed: 999
+  perforation_handling_strategy: bottom_point #bottom_point #multiple
+  fast_pyscal: True
+  training_set_fraction: 0.8
+  fault_tolerance: 0.1
+ert:
+  static_include_files: ../input_model/
+  realizations:
+    num_realizations: 250
+    required_success_percent: 80
+    max_runtime: 600
+  queue:
+    system: LOCAL
+    max_running: 4
+  ensemble_weights:
+    - 4
+    - 3
+    - 2
+    - 1
+    - 1
+    - 1
+    - 1
+    - 1
+    - 1
+
+model_parameters:
+  permeability:
+    min: 10
+    max: 10000
+  porosity:
+    min: 0.01
+    max: 0.35
+  bulkvolume_mult:
+    min: 1
+    max: 20
+  relative_permeability:
+    scheme: global
+    swirr:
+      min: 0.01
+      max: 0.2
+    swl:
+      min: 0.01
+      max: 0.2
+    swcr:
+      min: 0.1
+      max: 0.3
+    sorw:
+      min: 0.05
+      max: 0.3
+    krwend:
+      min: 0.5
+      max: 0.7
+    krowend:
+      min: 0.6
+      max: 0.9
+    nw:
+      min: 1.5
+      max: 4.5
+    now:
+      min: 2.5
+      max: 5.5
+  equil:
+    datum_depth: 4000
+    datum_pressure:
+      min: 380
+      max: 420
+    owc_depth:
+      min: 4980
+      max: 5020