<div>
<img
class="logo"
src="https://raw.githubusercontent.com/TGSAI/mdio.github.io/gh-pages/assets/images/mdio.png"
alt="MDIO"
width=200
height=auto
style="margin-top:10px;margin-bottom:10px"
/>
</div>
[][install_pip]
[][install_conda]
[][python version]
[][status]
[][apache 2.0 license]
[][tests]
[][codecov]
[][read the docs]
[][pre-commit]
[][black]
[][pypi_]
[][conda-forge_]
[pypi_]: https://pypi.org/project/multidimio/
[conda-forge_]: https://anaconda.org/conda-forge/multidimio
[status]: https://pypi.org/project/multidimio/
[python version]: https://pypi.org/project/multidimio
[read the docs]: https://mdio-python.readthedocs.io/
[tests]: https://github.com/TGSAI/mdio-python/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/TGSAI/mdio-python
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
[install_pip]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-pip-and-virtualenv
[install_conda]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-conda
**_"MDIO"_** is a library to work with large multidimensional energy datasets.
The primary motivation behind **MDIO** is to represent multidimensional
time series data in a format that makes it easier to use in resource assessment,
machine learning, and data processing workflows.
See the [documentation][read the docs] for more information.
This is not an official TGS product.
# Features
**Shared Features**
- Abstractions for common energy data types (see below).
- Cloud native chunked storage based on [Zarr][zarr] and [fsspec][fsspec].
- Lossy and lossless data compression using [Blosc][blosc] and [ZFP][zfp].
- Distributed reads and writes using [Dask][dask].
- Powerful command-line-interface (CLI) based on [Click][click]
**Domain Specific Features**
- Oil & Gas Data
- Import and export 2D - 5D seismic data types stored in SEG-Y.
- Import seismic interpretation, horizon, data. **FUTURE**
- Optimized chunking logic for various seismic types. **FUTURE**
- Wind Resource Assessment
- Numerical weather prediction models with arbitrary metadata. **FUTURE**
- Optimized chunking logic for time-series analysis and mapping. **FUTURE**
- [Xarray][xarray] interface. **FUTURE**
The features marked as **FUTURE** will be open-sourced at a later date.
# Installing MDIO
Simplest way to install _MDIO_ via [pip] from [PyPI]:
```shell
$ pip install multidimio
```
or install _MDIO_ via [conda] from [conda-forge]:
```shell
$ conda install -c conda-forge multidimio
```
> Extras must be installed separately on `Conda` environments.
For details, please see the [installation instructions]
in the documentation.
# Using MDIO
Please see the [Command-line Usage] for details.
For Python API please see the [API Reference] for details.
# Requirements
## Minimal
Chunked storage and parallelization: `zarr`, `dask`, `numba`, and `psutil`.\
SEG-Y Parsing: `segyio`\
CLI and Progress Bars: `click`, `click-params`, and `tqdm`.
## Optional
Distributed computing `[distributed]`: `distributed` and `bokeh`.\
Cloud Object Store I/O `[cloud]`: `s3fs`, `gcsfs`, and `adlfs`.\
Lossy Compression `[lossy]`: `zfpy`
# Contributing to MDIO
Contributions are very welcome.
To learn more, see the [Contributor Guide].
# Licensing
Distributed under the terms of the [Apache 2.0 license],
_MDIO_ 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.
This project template is based on [@cjolowicz]'s [Hypermodern Python Cookiecutter]
template.
[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[conda-forge]: https://conda-forge.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/TGSAI/mdio-python/issues
[pip]: https://pip.pypa.io/
[conda]: https://docs.conda.io/
[dask]: https://www.dask.org/
[zarr]: https://zarr.dev/
[fsspec]: https://filesystem-spec.readthedocs.io/en/latest/
[s3fs]: https://s3fs.readthedocs.io/
[gcsfs]: https://gcsfs.readthedocs.io/
[adlfs]: https://github.com/fsspec/adlfs
[blosc]: https://www.blosc.org/
[zfp]: https://computing.llnl.gov/projects/zfp
[xarray]: https://xarray.dev/
[click]: https://palletsprojects.com/p/click/
<!-- github-only -->
[apache 2.0 license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE
[contributor guide]: https://github.com/TGSAI/mdio-python/blob/main/CONTRIBUTING.md
[command-line usage]: https://mdio-python.readthedocs.io/en/latest/usage.html
[api reference]: https://mdio-python.readthedocs.io/en/latest/reference.html
[installation instructions]: https://mdio-python.readthedocs.io/en/latest/installation.html
Raw data
{
"_id": null,
"home_page": "https://mdio.dev",
"name": "multidimio",
"maintainer": "Altay Sansal",
"docs_url": null,
"requires_python": ">=3.9,<3.13",
"maintainer_email": "altay.sansal@tgs.com",
"keywords": "mdio,multidimio,seismic,wind,data",
"author": "TGS",
"author_email": "sys-opensource@tgs.com",
"download_url": "https://files.pythonhosted.org/packages/12/4e/e873e70167c5f27c30a12985a3f3d27bcefec7fa6f665919a023980a13fb/multidimio-0.7.2.tar.gz",
"platform": null,
"description": "<div>\n <img\n class=\"logo\"\n src=\"https://raw.githubusercontent.com/TGSAI/mdio.github.io/gh-pages/assets/images/mdio.png\"\n alt=\"MDIO\"\n width=200\n height=auto\n style=\"margin-top:10px;margin-bottom:10px\"\n />\n</div>\n\n[][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[][black]\n\n[][pypi_]\n[][conda-forge_]\n\n[pypi_]: https://pypi.org/project/multidimio/\n[conda-forge_]: https://anaconda.org/conda-forge/multidimio\n[status]: https://pypi.org/project/multidimio/\n[python version]: https://pypi.org/project/multidimio\n[read the docs]: https://mdio-python.readthedocs.io/\n[tests]: https://github.com/TGSAI/mdio-python/actions?workflow=Tests\n[codecov]: https://app.codecov.io/gh/TGSAI/mdio-python\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n[install_pip]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-pip-and-virtualenv\n[install_conda]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-conda\n\n**_\"MDIO\"_** is a library to work with large multidimensional energy datasets.\nThe primary motivation behind **MDIO** is to represent multidimensional\ntime series data in a format that makes it easier to use in resource assessment,\nmachine learning, and data processing workflows.\n\nSee the [documentation][read the docs] for more information.\n\nThis is not an official TGS product.\n\n# Features\n\n**Shared Features**\n\n- Abstractions for common energy data types (see below).\n- Cloud native chunked storage based on [Zarr][zarr] and [fsspec][fsspec].\n- Lossy and lossless data compression using [Blosc][blosc] and [ZFP][zfp].\n- Distributed reads and writes using [Dask][dask].\n- Powerful command-line-interface (CLI) based on [Click][click]\n\n**Domain Specific Features**\n\n- Oil & Gas Data\n - Import and export 2D - 5D seismic data types stored in SEG-Y.\n - Import seismic interpretation, horizon, data. **FUTURE**\n - Optimized chunking logic for various seismic types. **FUTURE**\n- Wind Resource Assessment\n - Numerical weather prediction models with arbitrary metadata. **FUTURE**\n - Optimized chunking logic for time-series analysis and mapping. **FUTURE**\n - [Xarray][xarray] interface. **FUTURE**\n\nThe features marked as **FUTURE** will be open-sourced at a later date.\n\n# Installing MDIO\n\nSimplest way to install _MDIO_ via [pip] from [PyPI]:\n\n```shell\n$ pip install multidimio\n```\n\nor install _MDIO_ via [conda] from [conda-forge]:\n\n```shell\n$ conda install -c conda-forge multidimio\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 MDIO\n\nPlease see the [Command-line Usage] for details.\n\nFor Python API please see the [API Reference] for details.\n\n# Requirements\n\n## Minimal\n\nChunked storage and parallelization: `zarr`, `dask`, `numba`, and `psutil`.\\\nSEG-Y Parsing: `segyio`\\\nCLI and Progress Bars: `click`, `click-params`, and `tqdm`.\n\n## Optional\n\nDistributed computing `[distributed]`: `distributed` and `bokeh`.\\\nCloud Object Store I/O `[cloud]`: `s3fs`, `gcsfs`, and `adlfs`.\\\nLossy Compression `[lossy]`: `zfpy`\n\n# Contributing to MDIO\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_MDIO_ 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 maintainer is\n[Altay Sansal](https://github.com/tasansal) with the support of\nmany more great colleagues.\n\nThis project template is based on [@cjolowicz]'s [Hypermodern Python Cookiecutter]\ntemplate.\n\n[@cjolowicz]: https://github.com/cjolowicz\n[pypi]: https://pypi.org/\n[conda-forge]: https://conda-forge.org/\n[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n[file an issue]: https://github.com/TGSAI/mdio-python/issues\n[pip]: https://pip.pypa.io/\n[conda]: https://docs.conda.io/\n[dask]: https://www.dask.org/\n[zarr]: https://zarr.dev/\n[fsspec]: https://filesystem-spec.readthedocs.io/en/latest/\n[s3fs]: https://s3fs.readthedocs.io/\n[gcsfs]: https://gcsfs.readthedocs.io/\n[adlfs]: https://github.com/fsspec/adlfs\n[blosc]: https://www.blosc.org/\n[zfp]: https://computing.llnl.gov/projects/zfp\n[xarray]: https://xarray.dev/\n[click]: https://palletsprojects.com/p/click/\n\n<!-- github-only -->\n\n[apache 2.0 license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE\n[contributor guide]: https://github.com/TGSAI/mdio-python/blob/main/CONTRIBUTING.md\n[command-line usage]: https://mdio-python.readthedocs.io/en/latest/usage.html\n[api reference]: https://mdio-python.readthedocs.io/en/latest/reference.html\n[installation instructions]: https://mdio-python.readthedocs.io/en/latest/installation.html\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Cloud-native, scalable, and user-friendly multi dimensional energy data!",
"version": "0.7.2",
"project_urls": {
"Changelog": "https://github.com/TGSAI/mdio-python/releases",
"Documentation": "https://mdio-python.readthedocs.io",
"Homepage": "https://mdio.dev",
"Repository": "https://github.com/TGSAI/mdio-python"
},
"split_keywords": [
"mdio",
"multidimio",
"seismic",
"wind",
"data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b28cdfac4cf4a35403000fd150a64a259fbe70a0118f60d823067286d9d47df9",
"md5": "e0e584ad4c18ee23b74295ee6aaa2d28",
"sha256": "d16804069cedd5c0767f43520b27ce1e5673c19be460525f4b594b32dbccabe6"
},
"downloads": -1,
"filename": "multidimio-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0e584ad4c18ee23b74295ee6aaa2d28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.13",
"size": 76693,
"upload_time": "2024-03-12T16:29:22",
"upload_time_iso_8601": "2024-03-12T16:29:22.090944Z",
"url": "https://files.pythonhosted.org/packages/b2/8c/dfac4cf4a35403000fd150a64a259fbe70a0118f60d823067286d9d47df9/multidimio-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "124ee873e70167c5f27c30a12985a3f3d27bcefec7fa6f665919a023980a13fb",
"md5": "11ae85e72d62d52ddb5bd9fb0b0f9326",
"sha256": "0ac371355cc3853863f7a5d2cb61d4da1afbee99650efbcb32f0278ea285e1dc"
},
"downloads": -1,
"filename": "multidimio-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "11ae85e72d62d52ddb5bd9fb0b0f9326",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.13",
"size": 64488,
"upload_time": "2024-03-12T16:29:23",
"upload_time_iso_8601": "2024-03-12T16:29:23.590416Z",
"url": "https://files.pythonhosted.org/packages/12/4e/e873e70167c5f27c30a12985a3f3d27bcefec7fa6f665919a023980a13fb/multidimio-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 16:29:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TGSAI",
"github_project": "mdio-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "multidimio"
}
JSON
