This release is a pre-release and may not be stable for production use.
Access the full documentation for SEGY-SAK from Gh-pages
SEGY-SAK aims to be your Python Swiss Army Knife for Seismic Data.
To do this SEGY-SAK offers two things; a commandline interface (CLI) for inspecting and converting SEG-Y data to a more friendly format called NETCDF4, and by providing convenience functions for the data using xarray. This includes lazy loading and streaming of data via the Xarray backend engine provided by SEGY-SAK.
We try hard to load the data the same way every time so your functions will work no-matter which cube/line you load. The xarray conventions we use are outlined in the documentation.
Why NETCDF4? Well, NETCDF4 is a fancy type of enclosed file binary format that allows for faster indexing and data retrieval than SEGY. We try our best to scan in the header information and to make it easy (or easier) to load SEGY in different formats, different configuration (2D, 2D gathers, 3D, 3D gathers). We do all this with the help of segyio which is a lower level interface to SEGY. If you stick to our xarray format of files we also offer utility functions to return to SEG-Y so you can export to other software.
Current Capabilities
CLI:
Convert 2D, 3D and gathers type SEG-Y to NETCDF4 and back. The NETCDF4 files are one line open with xarray.open_dataset.
Extract sub-volumes via cropping operations.
Read the EBCIDC/text header of the seismic file.
Perform a limited header scan.
Xarray and Python API:
Load SEG-Y data to a xarray.Dataset, dimensions are created by analysing trace header byte locations provided by the user.
Access header information and text headers in Python with convenience functions.
Select traces by UTM X and Y coordinates.
Installation
SEGY-SAK can be installed by using pip. Dependencies are specified in the pyproject.toml.
Python Package Index via pip
From the command line run the pip package manager
python -m pip install segysakInstall from source
Clone the SEGY-SAK Github repository and in the top level directory run
python -m pip installCLI Quick Start
The command line interface (CLI) provides an easy tool to convert or manipulate SEG-Y data. In your Python command-line environment it can be accessed by calling segysak.
For a full list of options run
segysak --helpAny SEG-Y files converted using the convert command. For example
segysak convert test.segyCan be loaded into Python using xarray.
test = xarray.open_dataset('test.SEISNC')Complete Documentation
The complete documentation for SEGY-SAK can be found at Gh-Pages
1 maintainer
Metadata
1 maintainer
Release files for segysak 0.1.dev116
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| segysak-0.1.dev116-py3-none-any.whl | Python 3 | none | any | Details for segysak-0.1.dev116-py3-none-any.whl |
Release files / segysak-0.1.dev116-py3-none-any.whl
| Download URL | segysak-0.1.dev116-py3-none-any.whl |
|---|---|
| Size | 92.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5694fd9316ce75ec59f1757cc84ffc7878fb905f536c6a4e21e57fa8593ca672
|
|
BLAKE2b-256 checksum How to use checksums |
e14538f029ed0c929609c6e851c105e298321e4875a79cdc520a2e69ee81260b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Security for segysak 0.1.dev116
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
