pyetp 0.0.39__py3-none-any.whl → 0.0.43a0__py3-none-any.whl

pyetp-0.0.43a0.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: pyetp
+Version: 0.0.43a0
+Summary: Interface with OSDU RDDMS using ETP protocol
+Author-email: Adam Cheng <52572642+adamchengtkc@users.noreply.github.com>
+License-Expression: Apache-2.0
+Project-URL: homepage, https://github.com/equinor/pyetp
+Classifier: Development Status :: 3 - Alpha
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy>=1.26.3
+Requires-Dist: websockets>=12.0
+Requires-Dist: lxml>=4.9.4
+Requires-Dist: pydantic>=1.10
+Requires-Dist: async-timeout>=5.0
+Requires-Dist: xtgeo>=4.0.0
+Requires-Dist: xsdata>=24.3.1
+Requires-Dist: etpproto>=1.0.7
+Dynamic: license-file
+
+![Build Status](https://github.com/equinor/pyetp/actions/workflows/ci.yml/badge.svg?branch=main)
+![codecov](https://codecov.io/gh/equinor/pyetp/graph/badge.svg?token=S2XDDKKI8U)
+![Python](https://img.shields.io/pypi/pyversions/pyetp)
+[![PyPI version](https://badge.fury.io/py/pyetp.svg)](https://badge.fury.io/py/pyetp)
+![License](https://img.shields.io/github/license/equinor/pyetp)
+
+# Installing the library
+This package is published to PyPI, and can be installed via:
+```bash
+pip install pyetp
+```
+
+## Local development
+Locally we suggest setting up a virtual environment, and installing the latest
+version of pip. Then install the library in editable mode along with the
+`dev`-dependency group. That is:
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install pip --upgrade
+pip install -e .
+pip install --group dev
+```
+
+
+## Linting and formatting
+We use ruff as a linter and formatter. To lint run:
+```bash
+ruff check
+```
+To run the formatter do:
+```bash
+ruff format
+```
+Or if you just want to check what could have been formatted:
+```bash
+ruff format --check
+```
+
+
+# RESQML versions
+The library is built and tested against RESQML v2.0.1. The spec can be
+downloaded
+[here](https://publications.opengroup.org/standards/energistics-standards/v231a).
+
+# Generated Python objects from RESQML spec
+Under `src/pyetp/resqml_objects` you will find Python objects generated from
+the RESQML xml spec.
+
+# Documentation
+See `/examples` for 2D grid usage
+
+`tests/test_mesh.py` for Unstructured/structured mesh
+
+# Running the unit tests
+We have set up unit tests against a local open-etp-server. To start this server
+run:
+```bash
+docker compose -f tests/compose.yml up [--detach]
+```
+If you want to re-use the same terminal window you should use the
+`--detach`-option, otherwise start a new terminal. We use `pytest` for testing,
+which can be run via:
+```bash
+py.test
+```
+
+# This library is under active development and subject to breaking changes

pyetp-0.0.43a0.dist-info/RECORD

@@ -0,0 +1,21 @@
+pyetp/__init__.py,sha256=Vu3_qz0AazlD4Q6ZLGdQVqZ7lhzqNLivpQRS3owD8SY,251
+pyetp/_version.py,sha256=b-D25r0F2ojY_bfYgOb171Q-k4AtL4xVxGGim3FNCxk,714
+pyetp/client.py,sha256=kZsPi2OPvbQKX6IVoAsrdZ9_ZDbZYEhHuHOhfbf3XxQ,37427
+pyetp/config.py,sha256=uGEx6n-YF7Rtgwckf0ovRKNOKgCUsiQx4IA0Tyiqafk,870
+pyetp/resqml_objects.py,sha256=j00e8scSh-yYv4Lpp9WjzLiaKqJWd5Cs7ROcJcxxFVw,50721
+pyetp/types.py,sha256=zOfUzEQcgBvveWJyM6dD7U3xJ4SCkWElewNL0Ml-PPY,6761
+pyetp/uri.py,sha256=Y05vuTO-XOurgDavBeoPGOidALoCKjCBIb7YHmfbAco,3115
+pyetp/utils_arrays.py,sha256=bLrb8H8TMjbpNLo0Zb9xYRUnM2W4BOf7WxOxWK4fcTc,10218
+pyetp/utils_xml.py,sha256=i11Zv2PuxW-ejEXxfGPYHvuJv7EHPYXwvgoe1U8fOUM,6826
+pyetp-0.0.43a0.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+resqml_objects/__init__.py,sha256=ilimTrQScFryxHrfZwZURVpW0li19bVnayUcHR7S_Fs,183
+resqml_objects/epc_readers.py,sha256=InYMlwjiZZRG9poQlWKFEOUNJmowGahXoNu_GniOaBw,3458
+resqml_objects/parsers.py,sha256=UZdBi3QmBq4ejwKI9Dse_lMqL5Bx2s3QNTs8TKS4fO0,427
+resqml_objects/serializers.py,sha256=JqRO6D6ExT5DrVyiNwBgNW28108f6spvxiVqJU0D9mc,352
+resqml_objects/v201/__init__.py,sha256=yL3jWgkyGAzr-wt_WJDV_eARE75NoA6SPEKBrKM4Crk,51630
+resqml_objects/v201/generated.py,sha256=Se0eePS6w25sfmnp2UBSkgzDGJ9c9Y2QqJgDRUTt_-Q,769527
+resqml_objects/v201/utils.py,sha256=WiywauiJRBWhdjUvbKhpltRjoBX3qWd7qQ0_FAmIzUc,1442
+pyetp-0.0.43a0.dist-info/METADATA,sha256=l1HO7RymATEmwlG6PCYhjLjzeBdl8Aj5qRd5pwtmrwY,2589
+pyetp-0.0.43a0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyetp-0.0.43a0.dist-info/top_level.txt,sha256=NrdXbidkT5QR4NjH6nv2Frixknqse3jZq7bnqNdVb5k,21
+pyetp-0.0.43a0.dist-info/RECORD,,

{pyetp-0.0.39.dist-info → pyetp-0.0.43a0.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.3
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

pyetp-0.0.43a0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+pyetp
+resqml_objects

resqml_objects/__init__.py

@@ -0,0 +1,7 @@
+from .parsers import parse_resqml_v201_object
+from .serializers import serialize_resqml_v201_object
+
+__all__ = [
+    "parse_resqml_v201_object",
+    "serialize_resqml_v201_object",
+]

resqml_objects/epc_readers.py

@@ -0,0 +1,114 @@
+import logging
+import pathlib
+import sys
+import zipfile
+
+import h5py
+import numpy as np
+import numpy.typing as npt
+
+import resqml_objects.v201 as ro_201
+
+from .parsers import parse_resqml_v201_object
+
+logger = logging.getLogger(__name__)
+
+
+def get_resqml_v201_objects(
+    epc_filename: str | pathlib.Path, log_failed_objects: bool = False
+) -> list[ro_201.AbstractObject]:
+    """This function is fairly brute-force; the function reads all files in the
+    provided EPC-file, and tries to parse it as one of the auto-generated
+    RESQML v2.0.1 objects. If you are unsure that all objects were included you
+    should set `log_failed_objects=True` and see if there are any missed
+    RESQML-objects. Objects such as `[Content_Types].xml`, `docProps/core.xml`,
+    and anything under the `_rels/`-directory are not RESQML-objects, and will
+    be logged as failed.
+
+
+    Parameters
+    ----------
+    epc_filename: str | pathlib.Path
+        The name of the EPC-file. Typically with an `.epc`-extension.
+    log_failed_objects: bool
+        Set to `True` in order to log the objects that were not parsed as
+        RESQML v2.0.1 objects along with their errors. Default is `False`.
+
+
+    Returns
+    -------
+    list[ro_201.AbstractObject]
+        A list of the parsed RESQML v2.0.1 objects.
+
+
+    See Also
+    --------
+    get_arrays_and_paths_in_hdf_file
+    """
+
+    if sys.version_info.major == 3 and sys.version_info.minor == 10:
+        raise NotImplementedError(
+            "The epc-reader 'get_resqml_v201_objects'-function does not work for "
+            "Python 3.10. Consider switching to Python 3.11 or up."
+        )
+
+    robjs = []
+    fail = {}
+
+    with zipfile.ZipFile(epc_filename, "r") as zf:
+        for zi in zf.infolist():
+            with zf.open(zi.filename) as f:
+                c = f.read()
+
+                try:
+                    robjs.append(parse_resqml_v201_object(c))
+                except AttributeError as e:
+                    fail[zi.filename] = e
+
+    if log_failed_objects:
+        logger.info(f"Failed to parse: {fail}")
+
+    return robjs
+
+
+def get_arrays_and_paths_in_hdf_file(
+    epc_hdf_filename: str | pathlib.Path,
+) -> dict[str, npt.NDArray[np.bool_ | np.number | np.character]]:
+    """In this function we read all arrays and their full paths in an
+    HDF5-file. In the context of an EPC-file this corresponds to the
+    `pathInHdfFile`-attribute in a RESQML/WITSML/PRODML-object that has
+    connected array data.
+
+
+    Parameters
+    ----------
+    epc_hdf_filename: str | pathlib.Path
+        The filename of the HDF5-file that is connected to an EPC-file. This is
+        typically the same filename as the EPC-file, but with the
+        `.epc`-extension replaced by `.h5`.
+
+
+    Returns
+    -------
+    dict[str | npt.NDArray[np.bool_ | np.number | np.character]
+        A dictionary mapping the `pathInHdfFile`-key to the actual array as a
+        NumPy-array.
+
+
+    See Also
+    --------
+    get_resqml_v201_objects
+    """
+    datasets = {}
+
+    def populate_datasets(name: str, obj: h5py.Dataset | h5py.Group) -> None:
+        if isinstance(obj, h5py.Dataset):
+            # The name does not include the top level group "/". This creates a
+            # mismatch between the PathInHdfFile-element in the RESQML
+            # documents.
+            datasets["/" + name] = np.array(obj)
+
+    with h5py.File(epc_hdf_filename, "r") as f:
+        f.visititems(populate_datasets)
+
+    return datasets

resqml_objects/parsers.py

@@ -0,0 +1,12 @@
+from lxml import etree
+from xsdata.formats.dataclass.context import XmlContext
+from xsdata.formats.dataclass.parsers import XmlParser
+
+import resqml_objects.v201 as ro_201
+
+
+def parse_resqml_v201_object(raw_data: bytes) -> ro_201.AbstractObject:
+    parser = XmlParser(context=XmlContext())
+
+    obj_name = etree.QName(etree.fromstring(raw_data).tag).localname
+    return parser.from_bytes(raw_data, getattr(ro_201, obj_name))

resqml_objects/serializers.py

@@ -0,0 +1,10 @@
+from xsdata.formats.dataclass.serializers import XmlSerializer
+from xsdata.formats.dataclass.serializers.config import SerializerConfig
+
+import resqml_objects.v201 as ro_201
+
+
+def serialize_resqml_v201_object(obj: ro_201.AbstractObject) -> bytes:
+    serializer = XmlSerializer(config=SerializerConfig())
+
+    return str.encode(serializer.render(obj))