diff --git a/README.md b/README.md index d31586b..ce2f912 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Tests](https://github.com/TGSAI/segy/workflows/Tests/badge.svg)][tests] [![Codecov](https://codecov.io/gh/TGSAI/segy/branch/main/graph/badge.svg)][codecov] -[![Read the documentation at https://segy.readthedocs.io/](https://img.shields.io/readthedocs/segy/latest.svg?label=Read%20the%20Docs)][read the docs] +[![Read the documentation at https://segy.readthedocs.io/](https://img.shields.io/readthedocs/segy/stable.svg?label=Read%20the%20Docs)][read the docs] [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit] [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)][ruff] @@ -23,11 +23,15 @@ [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/latest/installation.html#using-pip-and-virtualenv -[install_conda]: https://segy.readthedocs.io/en/latest/installation.html#using-conda +[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. @@ -126,6 +130,6 @@ with more modern tooling applied elsewhere!. [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/latest/usage.html -[api reference]: https://segy.readthedocs.io/en/latest/reference.html -[installation instructions]: https://segy.readthedocs.io/en/latest/installation.html +[command-line usage]: https://segy.readthedocs.io/en/stable/usage.html +[api reference]: https://segy.readthedocs.io/en/stable/reference.html +[installation instructions]: https://segy.readthedocs.io/en/stable/installation.html diff --git a/docs/installation.md b/docs/installation.md index 7d9cc46..98cdbcd 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -27,25 +27,21 @@ To check if installation was successful see [checking installation](#checking-in You can also install some optional dependencies (extras) like this: ```shell -$ pip install multidimio[distributed] -$ pip install multidimio[cloud] -$ pip install multidimio[lossy] +$ pip install segy[cloud] ``` -`distributed` installs [Dask][dask] for parallel, distributed processing.\ `cloud` installs [fsspec][fsspec] backed I/O libraries for [AWS' S3][s3fs], [Google's GCS][gcsfs], and [Azure ABS][adlfs].\ -`lossy` will install the [ZFPY][zfp] library for lossy chunk compression. -[dask]: https://www.dask.org/ [fsspec]: https://filesystem-spec.readthedocs.io/en/latest/ [s3fs]: https://s3fs.readthedocs.io/ [gcsfs]: https://gcsfs.readthedocs.io/ [adlfs]: https://github.com/fsspec/adlfs -[zfp]: https://computing.llnl.gov/projects/zfp ## Using `conda` +> 🚧👷🏻 Conda packaging is not available yet, but in progress 🚧👷🏻 + `segy` can also be installed in a `conda` environment. ```{note} diff --git a/pyproject.toml b/pyproject.toml index e563173..a6bc2a4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "segy" -version = "0.0.6" +version = "0.0.7" description = "The Ultimate Python SEG-Y I/O with Cloud Support and Schemas" authors = ["TGS "] maintainers = [