Skip to main content

The Ultimate Python SEG-Y I/O with Cloud Support and Schemas

Project description

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.

Features

The library utilizes numpy and fsspec, includes the reading from various local and remote resources at a high speed. It also allows the users to build their own SEG-Y specifications.

Installing segy

Clone the repo and install it using pip:

Simplest way to install segy is via pip from PyPI:

$ pip install segy

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)

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:

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

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!.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

segy-0.0.8.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

segy-0.0.8-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file segy-0.0.8.tar.gz.

File metadata

  • Download URL: segy-0.0.8.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for segy-0.0.8.tar.gz
Algorithm Hash digest
SHA256 57bd5b3210bcc57c3d4751bce5a13c6ba83fdd4b3468d7a9101fd885afb3a7ae
MD5 8cdb6f1ac97a2f75ec15ccd759013c31
BLAKE2b-256 c8784ab179967b17b484f1f87e1f81ac344c468aa57bb243de15f4c5210d07cf

See more details on using hashes here.

Provenance

File details

Details for the file segy-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: segy-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 32.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for segy-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9d0622fa73abd5bf32125aff04f857b2803658cc9f1ade7debe351b753c12520
MD5 bfcf9b4a96effdf4d038cd9e468c8830
BLAKE2b-256 08eb3fae6b8102b07d369099aff62c0f2c3fecedb9688a804cf5ec942eeb2412

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page