Segyio is a small LGPL licensed C library for easy interaction with SEG Y formatted seismic data, with language bindings for Python and Matlab. Segyio is an attempt to create an easy-to-use, embeddable, community-oriented library for seismic applications. Features are added as they are needed; suggestions and contributions of all kinds are very welcome.
- A low-level C interface with few assumptions; easy to bind to other languages.
- Read and write binary and textual headers.
- Read and write traces, trace headers.
- Easy to use and native-feeling python interface with numpy integration.
When Segyio is built and installed, you're ready to start programming! For
examples and documentation, check out the examples in the examples directory.
If you're using python, pydoc is used, so fire up your favourite python
interpreter and type help(segyio) to get started.
To build and use Segyio you need:
- A C99 compatible C compiler (tested mostly on gcc and clang)
- CMake version 2.8 or greater
- Python 2.7. We're working on 3.x support, help appreciated!
To build and install Segyio, perform the following actions in your console:
git clone https://github.com/Statoil/segyio
cd segyio
mkdir build
cmake .. -DCMAKE_BUILD_TYPE=Release
make
make install
Make install must be done as root for a system install; if you want to install
in your home directory, add -DCMAKE_INSTALL_PREFIX=~/ or some other
approperiate directory. Remember to update your $PATH!
To build the matlab bindings, invoke CMake with the option -DBUILD_MEX=ON. In
some environments the Matlab binaries are in a non-standard location, in which
case you need to help CMake find the matlab binaries by passing
-DMATLAB_ROOT=/path/to/matlab.
It's recommended to build in debug mode to get more warnings and to embed debug
symbols in the objects. Substituting Debug for Release in the
CMAKE_BUILD_TYPE is plenty.
Tests are located in the tests directory, and it's highly recommended that new features added are demonstrated for correctness and contract by adding a test. Feel free to use the tests already written as a guide.
After building Segyio you can run the tests with ctest, executed from the
build directory.
Please note that to run the python tests you need to let your environment know
where to find the segyio library files. On linux (bash) this is accomplished by being
in the build directory and executing: LD_LIBRARY_PATH=$PWD:$LD_LIBRARY_PATH
or by passing ctest a modified environment
LD_LIBRARY_PATH=$PWD:$LD_LIBRARY_PATH ctest.
We welcome all kinds of contributions, including code, bug reports, issues, feature requests and documentation. The preferred way of submitting a contribution is to either make an issue on github or by forking the project on github and making a pull request.
The current version supports:
- Reading EBCDIC Textual Header
- Reading Binary Header and selected fields.
- Read individual traces
- Inspect a SEGY file and identify crossline, inline and sample indexes
Small SEG Y formatted files are included in the repository for test purposes.
Phyiscally speaking the data is non-sensical, but it is reproducible by using
Segyio. The tests file are located in the tests/test-data directory. To
reproduce the data file, build Segyio and run the test program make-file.py
as such:
python examples/make-file.py out.sgy 50 1 6 20 25
If you have have small data files with a free license, feel free to submit it to the project!
Segyio was initially written and is maintained by Statoil ASA as a free, simple, easy-to-use way of interacting with seismic data that can be tailored to our needs, and as contribution to the free software community.