Update the readme file

.github/workflows/testing.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [3.6, 3.7, 3.8]
-        os: [ubuntu-latest]
+        os: [ubuntu-18.04]
 
     runs-on: ${{ matrix.os }}
 
@@ -24,7 +24,6 @@ jobs:
         python-version: ${{ matrix.python-version }}
 
     - name: Install Ubuntu dependencies
-      if: matrix.os == 'ubuntu-latest'
       run: |
         sudo add-apt-repository ppa:jokva/carolina
         sudo apt-get update

README.md

@@ -1,5 +1,44 @@
-# Carolina [![Build Status](https://travis-ci.org/Statoil/Carolina.svg?branch=master)](https://travis-ci.org/Statoil/Carolina)
+# Carolina
 
-Carolina is a [pyDAKOTA](https://github.com/wisdem/pyDAKOTA) fork maintained by
-Statoil and TNO.  Its raison d'être is to have easier building of a
-Python [Dakota](https://dakota.sandia.gov/) wrapper, without any MPI support.
+Carolina is a [pyDAKOTA](https://github.com/wisdem/pyDAKOTA) fork maintained by Equinor and TNO.  Its raison d'être is to have easier building of a Python [Dakota](https://dakota.sandia.gov/) wrapper, without any MPI support.
+
+## Installation
+
+Python version: Carolina supports Python version 3.6, 3.7, 3.8.
+
+In order to build Carolina, a number of Python and C/C++ libraries must be available.
+
+First make sure to install the dependencies from `requirements.txt`
+```bash
+    pip install -r requirements.txt
+```
+
+In addition, [Boost](https://www.boost.org/), including Boost.Python, and [Dakota](https://dakota.sandia.gov/) must be installed. This requires [CMake](https://cmake.org/) and a C/C++ compiler.
+
+The `BOOST_ROOT` environment variable can be set to the location of the boost library, if not in a default location.
+
+The `BOOST_PYTHON` can be set if a given version of `boost_python` is needed. For instance if the default of `boost_python3` is not available, and Python 3.8 is to be used:
+
+```bash
+    export BOOST_PYTHON=boost_python38
+```
+
+Carolina can then be installed with:
+
+```bash
+    pip install .
+```
+
+The library can then be tested by entering the tests directory and execute:
+
+```bash
+    pytest
+```
+
+### Installation for Dakota version 6.13 or above
+
+From Dakota version 6.13 a different set of boost libraries is needed: instead of `boost_signals`, `boost_program_options` is used. The Carolina setup script has not yet been updated to detect the Dakota version and use the correct library. Until then, apply the following patch to use Carolina with Dakota 6.13 and above:
+
+```bash
+    git apply dakota-6.13.patch
+```