Metadata-Version: 2.1
Name: ecl-data-io
Version: 2.1.0
Summary: A (lazy) parser and writer for the ecl output format.
Home-page: https://github.com/equinor/ecl-data-io
Author: Equinor
Author-email: fg_sib-scout@equinor.com
License: LGPL-3.0
Platform: any
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md

ecl-data-io
===========

Parser for the ecl output format, such as found in files with
extensions .UNRST, .EGRID, .INIT, etc. and also the corresponding
ascii files with extension .FUNRST, .FEGRID, .FINIT, etc.


Installation
============

ecl-data-io can be installed with pip:

```bash
pip install ecl-data-io
```

Getting started
===============

Ecl output files consist of a sequence of named arrays. ecl-data-io does not
interpret the names, but simply give you a tuple of the name and a numpy array
with the read function:

```
import ecl_data_io as eclio

for kw, arr in eclio.read("my_grid.egrid"):
    print(kw)

>>> "FILEHEAD"
>>> "GRIDHEAD"
>>> "COORD"
>>> "ZCORN"
>>> "ACTNUM"
>>> "MAPAXES"
```

For more information, see the docs: ecl-data-io.rtfd.io
