resfo-utilities 0.0.1__tar.gz

resfo_utilities-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 4.0.0]
+
+**Additional context**
+Add any other context about the problem here.

resfo_utilities-0.0.1/.github/dependabot.yml

@@ -0,0 +1,18 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    allow:
+      - dependency-type: "all"
+    groups:
+      all-deps:
+        patterns:
+          - "*"

resfo_utilities-0.0.1/.github/mypy-matcher.json

@@ -0,0 +1,18 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "mypy",
+      "severity": "error",
+      "pattern": [
+        {
+          "regexp": "^([^:]*):(\\d+):(?:(\\d+):)? error: (.*?)(?:  \\[(\\S+)\\])?$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4,
+          "code": 5
+        }
+      ]
+    }
+  ]
+}

resfo_utilities-0.0.1/.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,28 @@
+name: Publish Python 🐍 distributions 📦 to PyPI
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-n-publish:
+    environment:
+      name: pypi
+      url: https://pypi.org/p/resfo-utilities
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    - uses: actions/checkout@v5
+    - uses: actions/setup-python@v6
+      with:
+        python-version: 3.13
+        cache: 'pip'
+    - name: Install pypa/build
+      run: python -m pip install build
+    - name: Build a binary wheel and a source tarball
+      run: python -m build --sdist --wheel --outdir dist/ .
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

resfo_utilities-0.0.1/.github/workflows/testing.yml

@@ -0,0 +1,35 @@
+name: Run tests
+
+on:
+ push:
+   branches:
+     - main
+   tags: "*"
+ pull_request:
+env:
+  UV_FROZEN: true # https://docs.astral.sh/uv/configuration/environment/#uv_frozen
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  tests:
+    name: "Python ${{ matrix.python-version }}"
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --all-extras
+      - run: uv run pytest tests/
+      - run: uv run sphinx-build -W -n -E docs/source/ docs/output

resfo_utilities-0.0.1/.github/workflows/typing.yml

@@ -0,0 +1,43 @@
+name: Type checking
+
+on:
+ push:
+   branches:
+     - main
+ pull_request:
+
+env:
+  UV_FROZEN: true
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  type-checking:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        fetch-depth: 0
+        filter: tree:0
+
+    - uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        enable-cache: true
+        python-version: "3.13"
+
+    - run: |
+        uv sync --extra dev
+
+    - run: echo ::add-matcher::.github/mypy-matcher.json
+    - name: Run mypy
+      run: |
+        uv run mypy src

resfo_utilities-0.0.1/.gitignore

@@ -0,0 +1,48 @@
+# NFS files marked for deletion
+.nfs*
+
+# Temporary files when editing
+*.swp
+*~
+
+# IDE ignore
+## IntelliJ/PyCharm
+.idea
+*.iml
+## VS code
+.vscode
+## Eclipse?
+/.project
+# neovim (reversed rule)
+!.github
+
+# pytest ignores
+.pytest_cache
+
+# bytecode compiled python
+__pycache__
+
+# GNU tags
+/GPATH
+/GRTAGS
+/GTAGS
+/gtags.sh
+
+# MacOS
+*.DS_Store
+scratch.sparsebundle
+
+# Common Python virtual env dir
+/venv
+
+# python package. by distutils
+*.egg*
+
+## pip install without -e
+/build
+
+# cache folder for hypothesis framework
+.hypothesis
+
+# config for pyright
+pyrightconfig.json

resfo_utilities-0.0.1/.mypy.ini

@@ -0,0 +1,20 @@
+[mypy]
+
+warn_unused_configs = True
+disallow_any_generics = True
+disallow_subclassing_any = true
+disallow_untyped_calls = True
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+check_untyped_defs = True
+disallow_untyped_decorators = True
+warn_unused_ignores = True
+warn_redundant_casts = True
+strict_equality = True
+extra_checks = True
+
+[mypy-resfo.*]
+ignore_missing_imports = True
+
+[mypy-tests.*]
+ignore_errors = True

resfo_utilities-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+default_install_hook_types: [pre-commit]
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: check-json
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.18.2'
+    hooks:
+    -   id: mypy
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.11
+    hooks:
+    - id: ruff-check
+      args: [ --fix ]
+    - id: ruff-format
+
+-   repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.8.14
+    hooks:
+      - id: uv-lock
+
+- repo: local
+  hooks:
+  - id: pytest
+    name: pytest
+    entry: uv
+    args: [run, --all-extras, pytest, --benchmark-disable, tests]
+    language: system
+    types: [python]
+    stages: [pre-push]
+    pass_filenames: false
+  - id: docs
+    name: docs
+    entry: uv
+    args: [run, --all-extras, sphinx-build, -W, -n, -E, docs/source, docs/output]
+    language: system
+    stages: [pre-push]
+    pass_filenames: false

resfo_utilities-0.0.1/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py

resfo_utilities-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+The following is a set of guidelines for contributing to resfo-utilities.
+
+## Ground Rules
+
+1. We use pre-commit for checking code style
+1. All code must be testable and unit tested.
+
+## Commits
+
+We strive to keep a consistent and clean git history and all contributions should adhere to the following:
+
+1. All tests should pass on all commits(*)
+1. A commit should do one atomic change on the repository
+1. The commit message should be descriptive.
+
+We expect commit messages to follow the style described [here](https://chris.beams.io/posts/git-commit/). Also, focus on making clear the reasons why you made the change in the first place—the way things worked before the change (and what was wrong with that), the way they work now, and why you decided to solve it the way you did. A commit body is required for anything except very small changes.
+
+(*) Tip for making sure all tests passes, try out --exec while rebasing. You can then have all tests run per commit in a single command.
+## Pull Request Process
+
+1. Work on your own fork of the main repo
+1. Push your commits and make a draft pull request using the pull request template.
+1. Check that your pull request passes all tests.
+1. When all tests have passed and your are happy with your changes, change your pull request to "ready for review"
+   and ask for a code review.
+1. When your code has been approved—rebase, squash and merge your changes.

resfo_utilities-0.0.1/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: resfo-utilities
+Version: 0.0.1
+Summary: A utility library for working with the output of reservoir simulators.
+Author-email: Equinor <fg_sib-scout@equinor.com>
+Maintainer-email: Eivind Jahren <ejah@equinor.com>, Håkon Steinkopf Søhoel <hsoho@equinor.com>
+License: LGPL-3.0
+Project-URL: Homepage, https://github.com/equinor/resfo-utilities
+Project-URL: Repository, https://github.com/equinor/resfo-utilities
+Project-URL: Bug Tracker, https://github.com/equinor/resfo-utilities/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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <3.14,>=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: resfo
+Requires-Dist: shapely
+Requires-Dist: trimesh[easy]
+Requires-Dist: matplotlib
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx-rtd-theme; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: hypothesis; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-shapely; extra == "dev"
+Requires-Dist: pytest-benchmark; extra == "dev"
+
+resfo
+===========
+
+
+resfo-utilities is a library for working with output from
+ several reservoir simulators such as [opm
+flow](https://github.com/OPM/opm-simulators).
+
+Installation
+============
+
+`pip install resfo-utilities`
+
+
+How to contribute
+=================
+
+We use uv to have one synchronized development environment for all packages.
+See [installing uv](https://docs.astral.sh/uv/getting-started/installation/). We
+recommend either installing uv using your systems package manager, or creating
+a small virtual environment you intall base packages into (such as `uv` and `pre-commit`).
+
+Once uv is installed, you can get a development environment by running:
+
+```sh
+git clone https://github.com/equinor/resfo-utilities
+cd resfo-utilities
+uv sync --all-extras
+```
+
+
+You should set up `pre-commit` to ensure style checks are done as you commit:
+
+```bash
+uv run pre-commit install --hook-type pre-push
+```

resfo_utilities-0.0.1/README.md

@@ -0,0 +1,36 @@
+resfo
+===========
+
+
+resfo-utilities is a library for working with output from
+ several reservoir simulators such as [opm
+flow](https://github.com/OPM/opm-simulators).
+
+Installation
+============
+
+`pip install resfo-utilities`
+
+
+How to contribute
+=================
+
+We use uv to have one synchronized development environment for all packages.
+See [installing uv](https://docs.astral.sh/uv/getting-started/installation/). We
+recommend either installing uv using your systems package manager, or creating
+a small virtual environment you intall base packages into (such as `uv` and `pre-commit`).
+
+Once uv is installed, you can get a development environment by running:
+
+```sh
+git clone https://github.com/equinor/resfo-utilities
+cd resfo-utilities
+uv sync --all-extras
+```
+
+
+You should set up `pre-commit` to ensure style checks are done as you commit:
+
+```bash
+uv run pre-commit install --hook-type pre-push
+```

resfo_utilities-0.0.1/SECURITY.md

@@ -0,0 +1,16 @@
+If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it:
+
+1. **Do not** create a public GitHub issue for the vulnerability.
+2. Follow our guideline for Responsible Disclosure Policy at [https://www.equinor.com/about-us/csirt](https://www.equinor.com/about-us/csirt) to report the issue
+
+The following information will help us triage your report more quickly:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+We prefer all communications to be in English.

resfo_utilities-0.0.1/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx_rtd_theme

resfo_utilities-0.0.1/docs/source/api_reference.rst

@@ -0,0 +1,10 @@
+API Reference
+=============
+
+.. autoclass:: resfo_utilities.CornerpointGrid
+   :members:
+
+.. autoclass:: resfo_utilities.InvalidEgridFileError
+
+.. autoclass:: resfo_utilities.MapAxes
+   :members:

resfo_utilities-0.0.1/docs/source/conf.py

@@ -0,0 +1,23 @@
+project = "resfo-utilities"
+copyright = "2022, Equinor"
+author = "Equinor"
+release = "1.0.0"
+
+
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.intersphinx"]
+intersphinx_mapping = {
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "python": ("https://docs.python.org/3", None),
+}
+nitpick_ignore = [
+    ("py:class", "np.float32"),
+    ("py:class", "numpy.float32"),
+    ("py:class", "collections.abc.Buffer"),
+    ("py:class", "npt.ArrayLike"),
+    ("py:class", "ArrayLike"),
+    ("py:class", "npt.NDArray"),
+    ("py:class", "np.bool_"),
+]
+language = "python"
+html_theme = "sphinx_rtd_theme"
+autodoc_type_aliases = {"npt.ArrayLike": "ArrayLike"}

resfo_utilities-0.0.1/docs/source/glossary.rst

@@ -0,0 +1,23 @@
+Glossary
+========
+
+.. glossary::
+
+    corner-point grid
+        A corner-point grid is a tessellation of a 3D volumne where
+        each cell is a hexahedron. See the `corner-point grid wikipedia page`_  or
+        `OPM Flow manual`_ section 6.2.2 for more information.
+
+    pillar
+        In a :term:`corner-point grid` the pillars are a set of straight lines used
+        to define each cell. The 8 corner vertecies of each cell is determined by
+        the giving the height along four adjecent pillars.
+
+    UTM-coordinates
+        The Universal Transverse Mercator (UTM) is a coordinate system based on
+        the transverse Mercator map projection of the Earth spheroid. See
+        the `UTM wikipedia page`_.
+
+.. _OPM Flow manual: https://opm-project.org/wp-content/uploads/2023/06/OPM_Flow_Reference_Manual_2023-04_Rev-0_Reduced.pdf
+.. _corner-point grid wikipedia page: https://en.wikipedia.org/wiki/Corner-point_grid
+.. _UTM wikipedia page: https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system

resfo_utilities-0.0.1/docs/source/index.rst

@@ -0,0 +1,11 @@
+======================================================================
+resfo-utilities: A library for working with reservoir simulator output
+======================================================================
+
+
+.. toctree::
+   :hidden:
+
+   self
+   glossary
+   api_reference

resfo_utilities-0.0.1/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "resfo-utilities"
+description="A utility library for working with the output of reservoir simulators."
+readme = "README.md"
+requires-python = ">=3.11, <3.14"
+classifiers=[
+    "Development Status :: 1 - Planning",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = ["numpy","resfo", "shapely", "trimesh[easy]", "matplotlib"]
+dynamic=["version"]
+
+authors = [
+    {name="Equinor", email="fg_sib-scout@equinor.com"},
+]
+
+maintainers = [
+    {name="Eivind Jahren", email="ejah@equinor.com"},
+    {name="Håkon Steinkopf Søhoel", email="hsoho@equinor.com"},
+]
+
+[project.license]
+text = "LGPL-3.0"
+
+[project.urls]
+"Homepage" = "https://github.com/equinor/resfo-utilities"
+"Repository" = "https://github.com/equinor/resfo-utilities"
+"Bug Tracker" = "https://github.com/equinor/resfo-utilities/issues"
+
+[project.optional-dependencies]
+doc = [
+    "sphinx",
+    "sphinx-rtd-theme",
+]
+dev = [
+    "pytest",
+    "hypothesis",
+    "pre-commit",
+    "mypy",
+    "types-shapely",
+    "pytest-benchmark",
+]
+
+[tool.setuptools_scm]
+
+[tool.ruff]
+src = ["src"]
+line-length = 88
+
+[tool.pytest.ini_options]
+addopts = "-ra --strict-markers"
+
+[tool.uv]
+fork-strategy = "requires-python"

resfo_utilities-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

resfo_utilities-0.0.1/src/resfo_utilities/__init__.py

@@ -0,0 +1,3 @@
+from ._cornerpoint_grid import CornerpointGrid, InvalidEgridFileError, MapAxes
+
+__all__ = ["CornerpointGrid", "InvalidEgridFileError", "MapAxes"]