liespeters / fieldopt

New main repository for the FieldOpt project

FieldOpt

Petroleum Field Development Optimization Framework.

License

The FieldOpt project as a whole, except for the WellIndexCalculator, is provided under the GNU General Public License Version 3. A verbatim copy of the license (copied September 9. 2016) can be found here. The WellIndexCalculator is provided under the GNU Lesser Public License Version 3.

FieldOpt is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

FieldOpt is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with FieldOpt. If not, see http://www.gnu.org/licenses/.

Quick Setup Guide

This quick setup guide has been tested with Ubuntu 16.04.

1. Install the the libraries available in the repositories:

sudo apt-get install \
build-essential cmake git \
qt5-default \
libboost-all-dev \
libhdf5-dev \
libeigen3-dev \
libopenmpi-dev

# Create a symlink for the Eigen3 header files
sudo ln -s /usr/include/eigen3/Eigen /usr/include/Eigen

2. Install gtest:

sudo apt-get install libgtest-dev
cd /usr/src/gtest
sudo cmake CMakeLists.txt
sudo make
sudo cp *.a /usr/lib

3. Install rpolyplusplus:

# Clone the repo into some directory
git clone https://github.com/sweeneychris/RpolyPlusPlus.git
cd RpolyPlusPlus
cmake CMakeLists.txt
make
sudo mkdir /usr/include/RpolyPlusPlus
sudo cp lib/librpoly_plus_plus.so /usr/lib
sudo cp src/*.h /usr/include/RpolyPlusPlus

4. Build and Install ERT:

git clone https://github.com/Ensembles/ert.git
mkdir ert-build
cd ert-build
cmake ../ert
make
sudo make install

5. Clone FieldOpt

# Clone FieldOpt into some directory
git clone --recursive https://github.com/PetroleumCyberneticsGroup/FieldOpt.git

The WellIndexCalculator directory is a repository within the main FieldOpt directory. By cloning the main FieldOpt repository using the recursive flag (as in the above command), the WellIndexCalculator repository should automatically be cloned into the FieldOpt repository. If this is the case (check that the FieldOpt directory in your system contains the WellIndexCalculator directory, and that this directory is non-empty), then you can proceed with building FieldOpt (step 6).

If the above commands gives you the following message:

...    
Submodule 'FieldOpt/FieldOpt-WellIndexCalculator' ([email protected]:PetroleumCyberneticsGroup/FieldOpt-WellIndexCalculator.git) registered for path 'FieldOpt/FieldOpt-WellIndexCalculator'                                                                     
Submodule 'FieldOpt/Optimization/experimental_constraints' ([email protected]:PetroleumCyberneticsGroup/experimental_constraints.git) registered for path 'FieldOpt/Optimization/experimental_constraints'                                                       
Cloning into 'FieldOpt/FieldOpt-WellIndexCalculator'...                                                                        
Permission denied (publickey).                                                                                             fatal: Could not read from remote repository.                                                                                      
Please make sure you have the correct access rights
and the repository exists.

please try one of the following:

-step into the FieldOpt directory and fetch the WellIndexCalculator subrepo manually:

cd FieldOpt
git submodule update --recursive --remote

-add your SSH key to your GitHub account and clone the FieldOpt repo with the recursive flag again. Here's how to create an SSH key and add it to your Github account.

The FieldOpt directory should have the following structure:

FieldOpt
│   
└───examples
│   └───Flow
│   └───ECLIPSE
│   └───ADGPRS        
│   horzwell_bhp.json
│   horzwell_perforation.json
│
└───FieldOpt
│   │   
│   └───ConstraintMath
│   └───ERTWrapper
│   └───FieldOpt-WellIndexCalculator
│   └───Hdf5SummaryReader
│   └───Model
│   └───Optimization
│   └───Reservoir
│   └───Runner
│   └───Settings
│   └───Simulation
│   └───Utilities
│   CMakeLists.txt
│    
└───tools
│   └───ipython_notebooks
│   └───python_scripts
│   └───wic-benchmark-results
│   
│ command_line_build.sh
│ copyright_template
│ create_release.sh
│ Doxyfile
│ LICENSE.md
│ logo.png
│ README.md
│ run_tests.sh

6. Build FieldOpt

Here we are setting the FieldOpt build directory outside the main FieldOpt directory, so these two directories should be alongside each other:

FieldOpt
FieldOpt-build

Make the build directory and perform the make commands:

mkdir Fieldopt-build
cd Fieldopt-build
cmake ../FieldOpt/FieldOpt
make

7. Test that FieldOpt is working:

# Run the unit tests
make test

# Run the executables
./FieldOpt --help
./WellIndexCalculator --help

8. Install a simulator. Either Flow, AD-GPRS or ECL100.

AD-GPRS Libraries

Because ADGPRS is linked with an old version of OpenMPI, we need to use the same version to be able to launch it from within FieldOpt. We also need to use a boost library linked with the same OpenMPI version.

OpenMPI

The dependencies and source for OpenMPI version 1.4.3 can be found here. Install the dependencies, download the source and extract it. Then configure the package and install it to the opt directory:

mkdir build
cd build
../configure --prefix=/opt/openmpi-1.4.3/
sudo make all install

Boost

Download version 1.57 of the boost libraries here. Extract the contents and run

./booststrap.sh

Open the generated project-config.jam file and add a new line:

using mpi : /opt/openmpi-1.4.3/bin/mpicxx ;

And finally install the libraries to the opt directory:

sudo ./b2 --prefix=/opt/boost_1-57/