Merge pull request #156 from joakim-hove/readme-updates

Udate README to inline the examle file

README.md

@@ -57,11 +57,12 @@ arguments you must at least add:
 
 ```
 -DCMAKE_PREFIX_PATH=/local/ert/install
+-DCMAKE_INSTALL_PREFIX=/local/ert/install
 ```
 
 in addition you probably want to pass `-DCMAKE_INSTALL_PREFIX` to configure where
-the `libres` distribuion should be installed, normally that will be the same
-location where you have already installed `libecl`. 
+the `ert` distribuion should be installed, normally that will be the same
+location where you have already installed `libecl` and `libres`. 
 
 
 #### 5. Run `make` to compile `ert`
@@ -87,10 +88,78 @@ you might want to configure e.g. queue system in the `site-config` file, but
 that is not strictly necessary for a basic test.
 
 In the location `test-data/local/example_case` is a small ert case which can be
-used to verify that your installation is basically sound:
+used to verify that your installation is basically sound. The example config
+file looks like this:
+```
+-- This ert configuration file is an example which can be used to check that your
+-- local ert installation is basically sane. This example is not meant to be used
+-- as an automatically run integration test, rather it is meant to be tested
+-- interactively. In addition to the compiled application this will also verify that
+-- the various configuration files are reasonably correctly stitched together.
+--
+-- To actually test this invoke the ert binary you have installed and give the path to
+-- this file as argument:
+--
+--    /path/to/installed/ert/bin/ert example.ert
+-- 
+-- The example is based on the ECLIPSE100 forward model, that implies that you must
+-- configure the local eclipse related details corresponding to your site[1].
+-- 
+-- NB: the current case has *not* been carefully constructed to demonstrate the
+-- capabilities of ert; from a model updating perspective the current case is
+-- totally uninteresting.
+-- 
+-- [1]: This amounts to editing the file ecl_config.yml in the res.fm.ecl python
+-- package from the libres installation. See the documentation in the
+-- ecl_config.yml example file supplied with the libres distribution, or
+-- alternatively the "Post install configuration" section in the libres README. 
+
+NUM_REALIZATIONS 20
+
+QUEUE_SYSTEM LOCAL
+QUEUE_OPTION LOCAL MAX_RUNNING 4
+
+RUNPATH      output/simulations/runpath/realisation-%d/iter-%d
+ENSPATH      output/storage
+
+ECLBASE   EXAMPLE%d
+DATA_FILE eclipse/model/SPE1.DATA
+REFCASE   eclipse/refcase/REFCASE
+
+GEN_KW MULT_PORO templates/poro.tmpl   poro.grdecl  parameters/poro.txt
+
+-- This job will copy the file eclipse/input/schedule to the runpath folder. 
+SIMULATION_JOB COPY_FILE eclipse/input/schedule  
+
+
+-- This forward model job requires that you have eclipse version 2016.02
+-- installed locally, feel free to modify this to use a different version if
+-- that is what you have installed.
+SIMULATION_JOB ECLIPSE100 2016.2 <ECLBASE>
+
+OBS_CONFIG observations/observations.txt
+
+
+-- This tells ert that you want to load all summary vectors starting with 'W'. 
+-- 'F' and 'BPR'. To be able to use the wildcard notation this way you need to 
+-- specify a REFCASE.
+
+SUMMARY W*
+SUMMARY F*
+SUMMARY BPR*
+```
+
+**NB: Depending on which reservoir simulator versions you have installed locally
+you might have to change the eclipse version number 2016.2 to something else.**
+
+To actually test this go to the `test-data/local/example_case` directory and
+start `ert` by giving the full path to the installed binary:
 
+```
    cd test-data/local/example_case
-   ert example.ert
-
-Depending on the eclipse100 version available at your site you might have to
-modify the `SIMULATION_JOB` keyword.
+   /local/ert/install/bin/ert example.ert
+```
+
+Then the `ert` gui should come up and you can press the `Run simulations`
+button. In addition to the gui there is a simple text interface which
+can be invoked with the `--text` option.