Metadata-Version: 2.1
Name: ecl-data-io
Version: 3.1.1
Summary: A (lazy) parser and writer for the ecl output format.
Author-email: Equinor <fg_sib-scout@equinor.com>
Maintainer-email: Eivind Jahren <ejah@equinor.com>
License: LGPL-3.0
Project-URL: Homepage, https://github.com/equinor/ecl-data-io
Project-URL: Repository, https://github.com/equinor/ecl-data-io
Project-URL: Documentation, https://ecl-data-io.readthedocs.io/en/stable/
Project-URL: Bug Tracker, https://github.com/equinor/ecl-data-io/issues
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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy <2
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: hypothesis ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'

ecl-data-io
===========
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![docs](https://readthedocs.org/projects/ecl-data-io/badge/?version=latest&style=plastic)](https://ecl-data-io.readthedocs.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](http://ecl-data-io.rtfd.io).
