Skip to content

Commit

Permalink
Update readme with build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Lars Petter Øren Hauge committed Jan 15, 2018
1 parent c4b38be commit 461679b
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,42 @@ SEGYVIEWER
=======

Segyviewer is a small LGPL licensed python library for easy viewing of SEG-Y
files. It uses the segyio library for reading files.
files. It uses the segyio library for reading files.

## Getting started ##

Segyviewer is available through pip and installed with

```bash
pip install segyviewer
```

to open segyviewer with your chosen <file.segy>
```bash
segyviewer <file.segy>
```

## Build Segyviewer

To build segyviewer you need:

* [Python](https://www.python.org/) 2.7 or 3.x.
* [numpy](http://www.numpy.org/) version 1.10 or greater
* [setuptools](https://pypi.python.org/pypi/setuptools) version 28 or greater
* [setuptools-scm](https://pypi.python.org/pypi/setuptools_scm)
* [PyQt4](https://www.riverbankcomputing.com/software/pyqt/download)
* [segyio](https://github.com/Statoil/segyio)
* [matplotlib](https://matplotlib.org/)

To build and install segyviewer, perform the following actions in your console:

```bash
git clone https://github.com/Statoil/segyviewer
cd segyviewer
python setup.py build
python setup.py install
```

Please note that the required library pyqt4 is not listed in requirements.txt. QT not longer
supports PyQt4 and as such it is not possible to pip install PyQt4.
Setup.py, which uses pip, would fail if PyQt4 was listed in requirements.txt.

0 comments on commit 461679b

Please sign in to comment.