Skip to content

Latest commit

 

History

History
158 lines (109 loc) · 5.69 KB

README.md

File metadata and controls

158 lines (109 loc) · 5.69 KB
Raw

PyPI Conda Python Version Status License

Tests Codecov Read the documentation at https://segy.readthedocs.io/

pre-commit Ruff

PyPI Downloads Conda Downloads

SEG-Y

🚧👷🏻 This project is under active development, expect breaking changes the to API 👷🏻🚧 - March, 2024

This is an efficient and comprehensive SEG-Y parsing library.

See the documentation for more information.

This is not an official TGS product.

Key Features

  • Thrive for SEG-Y correctness while allowing flexibility.
  • Utilize fast decoding and parsing logic (numpy + numba).
  • Use fsspec ecosystem to read / write files to and from disk, cloud, http, ftp.
  • Support legacy and current SEG-Y standards.
  • Allow users to specify and register their customizations as new "standards".
  • Header field names are canonical and interactive alias recommendation based on popular libraries.
  • Automatic detection of file endianness and SEG-Y revision.
  • Configuration mechanism to override bad headers that hinders automatic parsing.

Installing segy

Clone the repo and install it using pip:

Simplest way to install segy is via pip from PyPI:

$ pip install segy

or install segy via conda from conda-forge:

$ conda install -c conda-forge segy

Extras must be installed separately on Conda environments.

For details, please see the installation instructions in the documentation.

Using segy

Please see the Command-line Usage for details.

For Python API please see the API Reference for details.

Reading Capabilities

It supports reading from local and cloud files (object store). It can read:

  • Sequential traces (fastest)
  • Disjoint sequential regions (fast)
  • Random traces (slow)

The library will also try to infer the endianness and the revision of the SEG-Y file automatically. If it can't, users can override the endianness, revision, and more parameters using the settings.

High Performance

The performance is high and to be proven with upcoming benchmarks. The initial subjective benchmarks is very acceptable.

Flexibility

The library provides a fully flexible, schematized SEG-Y structure, including data models and JSON schema parsing and validation.

Predefined SEG-Y Standards

It supports predefined SEG-Y "standards" for various versions. However, some versions are still in progress and not all validation logic is implemented yet:

  • ✅ Rev 0 (1975)
  • ✅ Rev 1 (2002)
  • ✅ Rev 2 (2017)**
  • ✅ Rev 2.1 (2023)**

** The XML stanzas and extended trace headers are not currently supported.

Custom SEG-Y Standards

You can build your own SEG-Y "standard" with composition of specs for:

  • Text header (file + extended)
  • Binary header
  • Traces (header + extended header + samples)

Contributing to segy

Contributions are very welcome. To learn more, see the Contributor Guide.

Licensing

Distributed under the terms of the Apache 2.0 license. segy is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was established at TGS. Current maintainer is Altay Sansal with the support of many more great colleagues.

The CI/CD tooling is loosely based on Hypermodern Python Cookiecutter with more modern tooling applied elsewhere.