resfo-utilities 0.3.0b0__tar.gz

resfo_utilities-0.3.0b0/.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.3.0b0/.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.3.0b0/.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.3.0b0/.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.3.0b0/.github/workflows/testing.yml

@@ -0,0 +1,36 @@
+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", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --all-extras
+      - run: uv run pytest tests/
+      - run: uv run pytest --doctest-modules src/
+      - run: uv run sphinx-build -W -n -E docs/source/ docs/output

resfo_utilities-0.3.0b0/.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@v7
+      with:
+        enable-cache: true
+        python-version: "3.13"
+
+    - run: |
+        uv sync --all-extras
+
+    - run: echo ::add-matcher::.github/mypy-matcher.json
+    - name: Run mypy
+      run: |
+        uv run mypy src

resfo_utilities-0.3.0b0/.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.3.0b0/.mypy.ini

@@ -0,0 +1,24 @@
+[mypy]
+plugins = pydantic.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
+
+[mypy-hypothesis.*]
+ignore_missing_imports = True

resfo_utilities-0.3.0b0/.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+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
+        additional_dependencies: [hypothesis, pydantic, scipy-stubs]
+
+-   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: pytest-doctest
+    name: pytest-doctest
+    entry: uv
+    args: [run, --all-extras, pytest, --doctest-modules, src]
+    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.3.0b0/.readthedocs.yaml

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

resfo_utilities-0.3.0b0/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.3.0b0/LICENSE.md

@@ -0,0 +1,166 @@
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

resfo_utilities-0.3.0b0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: resfo-utilities
+Version: 0.3.0b0
+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: Documentation, https://resfo-utilities.readthedocs.io/en/stable/
+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
+License-File: LICENSE.md
+Requires-Dist: numpy
+Requires-Dist: resfo>=5.0.0b1
+Requires-Dist: scipy
+Requires-Dist: natsort
+Provides-Extra: testing
+Requires-Dist: hypothesis; extra == "testing"
+Requires-Dist: pydantic; extra == "testing"
+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: pre-commit; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest-benchmark; extra == "dev"
+Requires-Dist: scipy-stubs; extra == "dev"
+Dynamic: license-file
+
+resfo-utilities
+===============
+
+
+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.3.0b0/README.md

@@ -0,0 +1,36 @@
+resfo-utilities
+===============
+
+
+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.3.0b0/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.3.0b0/docs/requirements.txt

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