Skip to content

Commit 48eb538

Browse files
authored
update README.md (TGSAI#650)
1 parent b14a519 commit 48eb538

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@
3737
[install_pip]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-pip-and-virtualenv
3838
[install_conda]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-conda
3939

40+
> 🎉 MDIO v1 is out. Ingestion and export for SEG-Y is fully functional with templates! However, there may still
41+
> be minor issues. Please report any issues you encounter.
42+
43+
> 🚧👷🏻 We are actively working on updating the documentation and adding missing features to v1 release. Please
44+
> check back later for more updates!
45+
4046
**_"MDIO"_** is a library to work with large multidimensional energy datasets.
4147
The primary motivation behind **MDIO** is to represent multidimensional
4248
time series data in a format that makes it easier to use in resource assessment,
@@ -52,22 +58,17 @@ This is not an official TGS product.
5258

5359
- Abstractions for common energy data types (see below).
5460
- Cloud native chunked storage based on [Zarr][zarr] and [fsspec][fsspec].
55-
- Lossy and lossless data compression using [Blosc][blosc] and [ZFP][zfp].
61+
- Standardized models for lossy and lossless data compression using [Blosc][blosc] and [ZFP][zfp].
5662
- Distributed reads and writes using [Dask][dask].
5763
- Powerful command-line-interface (CLI) based on [Click][click]
5864

5965
**Domain Specific Features**
6066

6167
- Oil & Gas Data
6268
- Import and export 2D - 5D seismic data types stored in SEG-Y.
69+
- Optimized chunking logic for various seismic types using MDIO templates.
70+
- Native [Xarray][xarray] data model and interface wrapper.
6371
- Import seismic interpretation, horizon, data. **FUTURE**
64-
- Optimized chunking logic for various seismic types. **FUTURE**
65-
- Wind Resource Assessment
66-
- Numerical weather prediction models with arbitrary metadata. **FUTURE**
67-
- Optimized chunking logic for time-series analysis and mapping. **FUTURE**
68-
- [Xarray][xarray] interface. **FUTURE**
69-
70-
The features marked as **FUTURE** will be open-sourced at a later date.
7172

7273
# Installing MDIO
7374

@@ -99,7 +100,7 @@ For Python API please see the [API Reference] for details.
99100
## Minimal
100101

101102
Chunked storage and parallelization: `zarr`, `dask`, `numba`, and `psutil`.\
102-
SEG-Y Parsing: `segyio`\
103+
SEG-Y Parsing: `TGSAI/segy`\
103104
CLI and Progress Bars: `click`, `click-params`, and `tqdm`.
104105

105106
## Optional
@@ -125,17 +126,11 @@ please [file an issue] along with a detailed description.
125126

126127
# Credits
127128

128-
This project was established at [TGS](https://www.tgs.com/). Current maintainer is
129-
[Altay Sansal](https://github.com/tasansal) with the support of
129+
This project was established at [TGS](https://www.tgs.com/). The current maintainer is [Altay Sansal](https://github.com/tasansal) with the support of
130130
many more great colleagues.
131131

132-
This project template is based on [@cjolowicz]'s [Hypermodern Python Cookiecutter]
133-
template.
134-
135-
[@cjolowicz]: https://github.com/cjolowicz
136132
[pypi]: https://pypi.org/
137133
[conda-forge]: https://conda-forge.org/
138-
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
139134
[file an issue]: https://github.com/TGSAI/mdio-python/issues
140135
[pip]: https://pip.pypa.io/
141136
[conda]: https://docs.conda.io/

0 commit comments

Comments
 (0)