Examples
Hello world
The examples folder contains a few configuration files with low grid resolution and shorter simulation times (for initial testing of the framework). For example, by executing:
pofff -i single.toml -t 24,48,72
The following is the figure map_24h.png. You can compare your example results to this figure to evaluate if your example ran correctly:
Adding your results
The publication folder contains the configuration files used for the results in the pofff paper (see publication for details in the steps to reproduce the figures in the paper). For example, running inside that folder:
pofff -i results.toml -o YOURS -m single -t 24,48,72,96,120 -f all
generates the figures in the paper in addition to the new simulation labeled as the name of the outpur folder (“YOURS” in this case), e.g., for the compare_all_time_series.png:
Tip
One can always modify the plotting scripts to change the colors, line styles, font sizes, etc.
We welcome pull request with your configuration files to the examples folder for cases with better results (less error in the error_table_satmin-0.01_conmin-0.1.csv).
Note
One can always also generate the sparse_data.csv, time_series.csv, and spatial_map_Xh.csv files using other simulators and use the pofff tool to compare to the experimental data, forecast, CSIRO, MIT_M1, and CSSR data. To this end, you can add those files to a folder call “MY_SIMULATOR” and execute:
pofff -t 24,48,72,96,120 -m none -o MY_SIMULATOR -f all
Note that the spatial maps csvs need to be given in the x range of 0 to 2.8 m and z range of 0 to 1.2 m.
History matching
The flag -m can be set to everest or ert to run the history matchings, which also requires to set additional variables in the toml configuration file (e.g., parameters to history match, number of parallel runs, random seed). For example, to run the last iteration of the history matching in the pofff paper corresponding to everest_iter_3.toml:
pofff -i everest_iter_3.toml -o everest_iter_3 -m everest -t 24,48,72,96,120 -f all
Warning
If you are running everest_iter_3.toml locally in your machine, then you might need to decrease the number of parallel runs (cores = 50 in line 39) and maximum function evaluations (max_function_evaluations = 200000) to your system capabilities.
For additional examples on how to set the history matching studies using ert or everest, see/run the scripts in the tests and publication folder.
Note
We refer to the documentation of everest and ert for the description of the different keywords. While via the toml configuration files in pofff we have added the most common keywords, then one could always add additional keywords to the generated (after execution of pofff) everest (everest.yml) and ert (ert.ert) configuration files, and after running the history matching directly using the everest/poff command line executables. After the runs, one can always use pofff to postprocess the data and generate the figures, running with the flag -m none (see the profiling.py for an example of splitting the generation of the files, running of everest, and postprocessing). Please raise an issue for missing keywords in the toml configuration files that you would like to be added.