zmap reading via lib

Author: kwinkunks

CONTRIBUTING.md

@@ -4,15 +4,25 @@
 
 There are several important ways you can help; here are some examples:
 
-- Submitting bug reports and feature requests: see [Issues](https://github.com/agile-geoscience/kosu/issues).
+- Submitting bug reports and feature requests: see [Issues](https://github.com/agile-geoscience/gio/issues).
 - Proposing code for bug fixes and new features, then [making a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+- Contributing data files to test against. See below.
 - Fixing typos and generally improving the documentation.
 - Writing tutorials, examples, and how-to documents.
 
+
+## Contributing data files
+
+This is a data-driven project and data files are always helpful, especially if they differ substantially from examples we already have.
+
+Please ensure that data is open access and provide a licence file with it. please also make them as small as possible, preferably well under 1MB.
+
+
 ## Code of conduct
 
 We're fortunate to be part of a large professional community that conducts itself with mutual respect and consideration for others. Agile's [Code of Conduct](https://github.com/agile-geoscience/corporate/blob/main/CODE_OF_CONDUCT.md) is part of protecting these features for everyone, everywhere. Please read it.
 
+
 ## Authorship
 
 If you contribute a pull request to the project, please add yourself to `AUTHORS.md`.

README.md

@@ -1,42 +1,73 @@
 # gio
 
-Loading and saving various geoscience surface data formats (2D and 3D seismic horizons, grids, etc).
+[![Build and test](https://github.com/agile-geoscience/gio/actions/workflows/build-test.yml/badge.svg)](https://github.com/agile-geoscience/gio/actions/workflows/build-test.yml)
+[![PyPI status](https://img.shields.io/pypi/status/gio.svg)](https://pypi.org/project/gio//)
+[![PyPI versions](https://img.shields.io/pypi/pyversions/gio.svg)](https://pypi.org/project/gio//)
+[![PyPI license](https://img.shields.io/pypi/l/gio.svg)](https://pypi.org/project/gio/)
 
-Starting with:
+**Geoscience I/O for grids and horizons.**
+
+The goal of this project is to load and save various geoscience surface data formats (2D and 3D seismic horizons, grids, etc). The interchange formats are the `xarray.DataArray` (and `xarray.Dataset` where we need a collection of arrays). This format is convenient because it allows us to store a NumPy array with Pandas-like indexing (as opposed to ordinary NumPy positional indexing).
+
+We've started with:
 
 - OpendTect horizons
-- Petrel horizons
-  - IESX format
-  - IRAP format
 - ZMAP grids
+- Surfer grids
+- Petrel horizons
 
 **What formats would you like to see? [Make an issue](https://github.com/agile-geoscience/gio/issues).**
 
 
 ## Installation
 
-This library is not on PyPI yet, so you'll have to install it from GitHub:
+This library is on PyPI, so you can install it with:
 
-    python -m pip install --upgrade https://github.com/agile-geoscience/gio/archive/master.zip
+    pip install gio
 
+ To get the latest unstable release, you can install it from GitHub:
 
-## Contributing
+    python -m pip install --upgrade https://github.com/agile-geoscience/gio/archive/develop.zip
 
-Please get involved! We need:
 
-- Example data (open access data only)
-- Tutorials
-- Documentation
-- Parsers for various formats
+## Examples
+
+```python
+import gio
+
+da = gio.read_surfer(fname)
+da.plot()
+```
+
+See more examples in the **notebooks** folder.
+
+
+## Contributing
+
+Please get involved! See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 
 ## Testing
 
-You can run the tests (requires `pytest` and `pytest-cov`) with 
+You can run the tests (requires `pytest` and `pytest-cov`) with
 
     python run_tests.py
 
 
+## Building
+
+This repo uses PEP 517-style packaging. [Read more about this](https://setuptools.pypa.io/en/latest/build_meta.html) and [about Python packaging in general](https://packaging.python.org/en/latest/tutorials/packaging-projects/).
+
+Building the project requires `build`, so first:
+
+    pip install build
+
+Then to build `gio` locally:
+
+    python -m build
+
+The builds both `.tar.gz` and `.whl` files, either of which you can install with `pip`.
+
 ---
 
 © 2022 Agile Scientific, openly licenced under Apache 2.0