| Name | segy JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | The Ultimate Python SEG-Y I/O with Cloud Support and Schemas |
| upload_time | 2025-01-24 17:28:19 |
| maintainer | None |
| docs_url | None |
| author | Altay Sansal |
| requires_python | <3.14,>=3.10 |
| license | Apache-2.0 |
| keywords |
segy
seismic
data
geophysics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[][install_pip]
[][install_conda]
[][python version]
[][status]
[][apache 2.0 license]
[][tests]
[][codecov]
[][read the docs]
[][pre-commit]
[][ruff]
[][pypi_]
[][conda-forge_]
[pypi_]: https://pypi.org/project/segy/
[conda-forge_]: https://anaconda.org/conda-forge/segy
[status]: https://pypi.org/project/segy/
[python version]: https://pypi.org/project/segy
[read the docs]: https://segy.readthedocs.io/
[tests]: https://github.com/TGSAI/segy/actions/workflows/tests.yaml
[codecov]: https://app.codecov.io/gh/TGSAI/segy
[pre-commit]: https://github.com/pre-commit/pre-commit
[ruff]: https://github.com/astral-sh/ruff
[install_pip]: https://segy.readthedocs.io/en/stable/installation.html#using-pip-and-virtualenv
[install_conda]: https://segy.readthedocs.io/en/stable/installation.html#using-conda
# 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][read the docs] 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]:
```shell
$ pip install segy
```
or install `segy` via [conda] from [conda-forge]:
```shell
$ 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](https://www.tgs.com/). Current
maintainer is [Altay Sansal](https://github.com/tasansal) 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.
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[pypi]: https://pypi.org/
[conda-forge]: https://conda-forge.org/
[file an issue]: https://github.com/TGSAI/segy/issues
[pip]: https://pip.pypa.io/
[conda]: https://docs.conda.io/
<!-- github-only -->
[apache 2.0 license]: https://github.com/TGSAI/segy/blob/main/LICENSE
[contributor guide]: https://github.com/TGSAI/segy/blob/main/CONTRIBUTING.md
[command-line usage]: https://segy.readthedocs.io/en/stable/cli_usage.html
[api reference]: https://segy.readthedocs.io/en/stable/api_reference.html
[installation instructions]: https://segy.readthedocs.io/en/stable/installation.html
Raw data
{
"_id": null,
"home_page": null,
"name": "segy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": null,
"keywords": "segy, seismic, data, geophysics",
"author": "Altay Sansal",
"author_email": "altay.sansal@tgs.com",
"download_url": "https://files.pythonhosted.org/packages/89/da/3bc5baf7f6fc10472a8833e8d9977094b9c8bd3f0f9306f22002ca7a0fda/segy-0.4.0.tar.gz",
"platform": null,
"description": "[][install_pip]\n[][install_conda]\n[][python version]\n[][status]\n[][apache 2.0 license]\n\n[][tests]\n[][codecov]\n[][read the docs]\n\n[][pre-commit]\n[][ruff]\n\n[][pypi_]\n[][conda-forge_]\n\n[pypi_]: https://pypi.org/project/segy/\n[conda-forge_]: https://anaconda.org/conda-forge/segy\n[status]: https://pypi.org/project/segy/\n[python version]: https://pypi.org/project/segy\n[read the docs]: https://segy.readthedocs.io/\n[tests]: https://github.com/TGSAI/segy/actions/workflows/tests.yaml\n[codecov]: https://app.codecov.io/gh/TGSAI/segy\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[ruff]: https://github.com/astral-sh/ruff\n[install_pip]: https://segy.readthedocs.io/en/stable/installation.html#using-pip-and-virtualenv\n[install_conda]: https://segy.readthedocs.io/en/stable/installation.html#using-conda\n\n# SEG-Y\n\n> \ud83d\udea7\ud83d\udc77\ud83c\udffb This project is under active development, expect breaking changes\n> the to API \ud83d\udc77\ud83c\udffb\ud83d\udea7\n> _\\- March, 2024_\n\nThis is an efficient and comprehensive SEG-Y parsing library.\n\nSee the [documentation][read the docs] for more information.\n\nThis is not an official TGS product.\n\n## Key Features\n\n- Thrive for SEG-Y correctness while allowing flexibility.\n- Utilize fast decoding and parsing logic (`numpy` + `numba`).\n- Use `fsspec` ecosystem to read / write files to and from disk, cloud, `http`, `ftp`.\n- Support legacy and current SEG-Y standards.\n- Allow users to specify and register their customizations as new \"standards\".\n- Header field names are canonical and interactive alias recommendation based on popular libraries.\n- Automatic detection of file endianness and SEG-Y revision.\n- Configuration mechanism to override bad headers that hinders automatic parsing.\n\n## Installing `segy`\n\nClone the repo and install it using pip:\n\nSimplest way to install `segy` is via [pip] from [PyPI]:\n\n```shell\n$ pip install segy\n```\n\nor install `segy` via [conda] from [conda-forge]:\n\n```shell\n$ conda install -c conda-forge segy\n```\n\n> Extras must be installed separately on `Conda` environments.\n\nFor details, please see the [installation instructions]\nin the documentation.\n\n## Using `segy`\n\nPlease see the [Command-line Usage] for details.\n\nFor Python API please see the [API Reference] for details.\n\n### Reading Capabilities\n\nIt supports reading from local and cloud files (object store). It can read:\n\n- Sequential traces (fastest)\n- Disjoint sequential regions (fast)\n- Random traces (slow)\n\nThe library will also try to infer the endianness and the revision of the SEG-Y\nfile automatically. If it can't, users can override the endianness, revision, and\nmore parameters using the settings.\n\n### High Performance\n\nThe performance is high and to be proven with upcoming benchmarks. The initial\nsubjective benchmarks is very acceptable.\n\n### Flexibility\n\nThe library provides a fully flexible, schematized SEG-Y structure, including\ndata models and JSON schema parsing and validation.\n\n### Predefined SEG-Y Standards\n\nIt supports predefined SEG-Y \"standards\" for various versions. However, some versions\nare still in progress and not all validation logic is implemented yet:\n\n- \u2705 Rev 0 (1975)\n- \u2705 Rev 1 (2002)\n- \u2705 Rev 2 (2017)\\*\\*\n- \u2705 Rev 2.1 (2023)\\*\\*\n\n\\*\\* The XML stanzas and extended trace headers are not currently supported.\n\n### Custom SEG-Y Standards\n\nYou can build your own SEG-Y \"standard\" with composition of specs for:\n\n- Text header (file + extended)\n- Binary header\n- Traces (header + extended header + samples)\n\n## Contributing to `segy`\n\nContributions are very welcome.\nTo learn more, see the [Contributor Guide].\n\n## Licensing\n\nDistributed under the terms of the [Apache 2.0 license].\n`segy` is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue] along with a detailed description.\n\n## Credits\n\nThis project was established at [TGS](https://www.tgs.com/). Current\nmaintainer is [Altay Sansal](https://github.com/tasansal) with the support\nof many more great colleagues.\n\nThe CI/CD tooling is loosely based on [Hypermodern Python Cookiecutter]\nwith more modern tooling applied elsewhere.\n\n[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n[pypi]: https://pypi.org/\n[conda-forge]: https://conda-forge.org/\n[file an issue]: https://github.com/TGSAI/segy/issues\n[pip]: https://pip.pypa.io/\n[conda]: https://docs.conda.io/\n\n<!-- github-only -->\n\n[apache 2.0 license]: https://github.com/TGSAI/segy/blob/main/LICENSE\n[contributor guide]: https://github.com/TGSAI/segy/blob/main/CONTRIBUTING.md\n[command-line usage]: https://segy.readthedocs.io/en/stable/cli_usage.html\n[api reference]: https://segy.readthedocs.io/en/stable/api_reference.html\n[installation instructions]: https://segy.readthedocs.io/en/stable/installation.html\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The Ultimate Python SEG-Y I/O with Cloud Support and Schemas",
"version": "0.4.0",
"project_urls": {
"Documentation": "https://segy.readthedocs.io",
"Repository": "https://github.com/TGSAI/segy"
},
"split_keywords": [
"segy",
" seismic",
" data",
" geophysics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8adc11b184b4d75e56a3f671a93108dc49a775fc680280a5a06cc69d006eba62",
"md5": "a1ffada19de9a061979227b26b7f44bc",
"sha256": "e6bb1419a6d916f5c5edd68b2a6162dcd3f7ee0ffa7f66342b950cecbc0dcf20"
},
"downloads": -1,
"filename": "segy-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1ffada19de9a061979227b26b7f44bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 53891,
"upload_time": "2025-01-24T17:28:18",
"upload_time_iso_8601": "2025-01-24T17:28:18.607751Z",
"url": "https://files.pythonhosted.org/packages/8a/dc/11b184b4d75e56a3f671a93108dc49a775fc680280a5a06cc69d006eba62/segy-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "89da3bc5baf7f6fc10472a8833e8d9977094b9c8bd3f0f9306f22002ca7a0fda",
"md5": "f6c4765304c636f98b89fea765441d7a",
"sha256": "bf2d17dbf32e5cc86c443cf28b19ed90c67edad8ea6c69da39d0167f31d30daf"
},
"downloads": -1,
"filename": "segy-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "f6c4765304c636f98b89fea765441d7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 43803,
"upload_time": "2025-01-24T17:28:19",
"upload_time_iso_8601": "2025-01-24T17:28:19.788140Z",
"url": "https://files.pythonhosted.org/packages/89/da/3bc5baf7f6fc10472a8833e8d9977094b9c8bd3f0f9306f22002ca7a0fda/segy-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 17:28:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TGSAI",
"github_project": "segy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "segy"
}
