Files
opm-common/python/README.md
Joakim Hove 77795b5005 Add 'python/' from commit '278373703455ea6562a0f8e5278b4db46eb1fc7e'
git-subtree-dir: python
git-subtree-mainline: e8dbf7d8ee
git-subtree-split: 2783737034
2019-05-08 07:20:29 +02:00

52 lines
1.1 KiB
Markdown

# sunbeam [![Build Status](https://travis-ci.org/equinor/sunbeam.svg?branch=master)](https://travis-ci.org/equinor/sunbeam)
# Prerequisites:
Clone and build `ecl` from [Statoil/libecl](https://github.com/Statoil/libecl)
and `opm-commonr` from [OPM/opm-common](https://github.com/OPM/opm-common).
```
git clone https://github.com/Statoil/libecl
git clone https://github.com/OPM/opm-parser
mkdir libecl/build
mkdir opm-common/build
pushd libecl/build
cmake ..
make install
popd
pushd opm-common/build
cmake ..
make install
```
# Quick start (WIP)
Assumes you have built (and maybe installed) opm-common
```bash
git clone --recursive https://github.com/Statoil/sunbeam
mkdir sunbeam/build
pushd sunbeam/build
cmake ..
make
ctest # for running unit tests
```
# Obtaining test data
```bash
cd ~
git clone https://github.com/OPM/opm-data
cd opm-data/norne
```
With `opm-data` available, one can test sunbeam on Norne:
```python
import sunbeam
es = sunbeam.parse('NORNE_ATW2013.DATA', ('PARSE_RANDOM_SLASH', sunbeam.action.ignore))
len(es.faults())
```
Remember to have `~/sunbeam/build/python` in your `$PYTHONPATH`.