subscript 1.14.4__tar.gz → 1.14.5__tar.gz

subscript-1.14.5/.github/dependabot.yml

@@ -0,0 +1,7 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

{subscript-1.14.4 → subscript-1.14.5}/.github/workflows/codecov.yml

@@ -26,7 +26,7 @@ jobs:
         sudo apt-get update
         sudo apt-get install libegl1
 
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
 
     - name: Setup Python
       uses: actions/setup-python@v6

{subscript-1.14.4 → subscript-1.14.5}/.github/workflows/linting.yml

@@ -30,12 +30,12 @@ jobs:
 
     steps:
       - name: Checkout commit locally
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 

{subscript-1.14.4 → subscript-1.14.5}/.github/workflows/publish.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
 

{subscript-1.14.4 → subscript-1.14.5}/.github/workflows/subscript.yml

@@ -35,7 +35,7 @@ jobs:
           sudo apt-get install libegl1
 
       - name: Checkout commit locally
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
 

subscript-1.14.5/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: subscript
+Version: 1.14.5
+Summary: Equinor's collection of subsurface reservoir modelling scripts
+Author-email: Equinor <rnyb@equinor.com>
+License-Expression: GPL-3.0-only
+Project-URL: Homepage, https://github.com/equinor/subscript
+Project-URL: Repository, https://github.com/equinor/subscript
+Project-URL: Documentation, https://equinor.github.io/subscript
+Keywords: energy,subsurface,reservoir,scientific,engineering
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Natural Language :: English
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: resdata
+Requires-Dist: res2df
+Requires-Dist: ert>=10.2.0b13
+Requires-Dist: fmu-tools
+Requires-Dist: grid3d_maps
+Requires-Dist: jinja2
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: opm>=2023.04
+Requires-Dist: pandas
+Requires-Dist: pydantic
+Requires-Dist: pyscal
+Requires-Dist: pyyaml
+Requires-Dist: scipy
+Requires-Dist: seaborn
+Requires-Dist: xtgeo
+Provides-Extra: tests
+Requires-Dist: mypy; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-mock; extra == "tests"
+Requires-Dist: pytest-mpl; extra == "tests"
+Requires-Dist: pytest-xdist; extra == "tests"
+Requires-Dist: rstcheck; extra == "tests"
+Requires-Dist: rstcheck-core; extra == "tests"
+Requires-Dist: ruff; extra == "tests"
+Requires-Dist: types-Jinja2; extra == "tests"
+Requires-Dist: types-PyYAML; extra == "tests"
+Requires-Dist: types-python-dateutil; extra == "tests"
+Requires-Dist: pandas-stubs; extra == "tests"
+Requires-Dist: types-seaborn; extra == "tests"
+Requires-Dist: scipy-stubs; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: autoapi; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-argparse; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinx-togglebutton; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Dynamic: license-file
+
+# subscript
+
+[![subscript](https://github.com/equinor/subscript/actions/workflows/subscript.yml/badge.svg)](https://github.com/equinor/subscript/actions/workflows/subscript.yml)
+[![codecov](https://codecov.io/gh/equinor/subscript/branch/main/graph/badge.svg)](https://codecov.io/gh/equinor/subscript)
+![Python Version](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue.svg)
+[![License: GPL v3](https://img.shields.io/github/license/equinor/subscript)](https://www.gnu.org/licenses/gpl-3.0)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**subscript** is Equinor's collection of scripts used for subsurface reservoir modelling.
+
+---
+
+## Quick Reference
+
+* [**Documentation**](https://equinor.github.io/subscript)
+* [**Installation**](#installation)
+* [**Usage**](#usage)
+* [**Contributing**](https://equinor.github.io/subscript/contributing.html)
+
+---
+
+## Installation
+
+subscript can be installed via pip
+
+```sh
+pip install subscript
+```
+
+## Usage
+
+As a collection of utilities subscript has many different invocations and
+use cases. A complete overview can be found in the
+[documentation](https://equinor.github.io/subscript)
+for a complete overview.
+
+Note that some of these utilities may depend upon commercial third-party
+software.
+
+
+## Developing & Contributing
+
+All contributions are welcome. Please see the
+[Contributing document](https://equinor.github.io/subscript/contributing.html)
+for more details and instructions for getting started.
+
+
+## Documentation
+
+The documentation can be found at https://equinor.github.io/subscript

{subscript-1.14.4 → subscript-1.14.5}/pyproject.toml

@@ -6,14 +6,15 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-write_to = "src/subscript/version.py"
+version_file = "src/subscript/version.py"
 
 [project]
 name = "subscript"
 description = "Equinor's collection of subsurface reservoir modelling scripts"
 readme = "README.md"
 requires-python = ">=3.11"
-license = { file = "LICENSE" }
+license = "GPL-3.0-only"
+license-files = ["LICENSE"]
 authors = [
     { name = "Equinor", email = "rnyb@equinor.com" },
 ]
@@ -30,7 +31,6 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Natural Language :: English",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
 ]
 dynamic = ["version"]
 dependencies = [
@@ -149,7 +149,6 @@ module = [
     "xtgeo.*",
     "opm.*",
     "resdata.*",
-    "res2df.*",
     "ert",
     "grid3d_maps.*",
     "fmu.tools.*",
@@ -197,6 +196,7 @@ select = [
     "RUF", # RUFF specific rules
     "PL",  # pylint
     "B",  # flake8-bugbear
+    "ANN",  # flake8-annotations
 ]
 ignore = [
     "C901",  # complex-structure
@@ -207,6 +207,13 @@ ignore = [
     "PLW2901",  # redefined-loop-name
 ]
 
+[tool.ruff.lint.extend-per-file-ignores]
+"src/subscript/sunsch/time_vector.py" = ["ANN"]
+"src/subscript/casegen_upcars/*" = ["ANN"]
+"src/subscript/field_statistics/*" = ["ANN"]
+"src/subscript/fmu_copy_revision/*" = ["ANN"]
+"tests/*" = ["ANN"]
+
 [tool.ruff.lint.isort]
 combine-as-imports = true
 

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/__init__.py

@@ -9,7 +9,7 @@ except metadata.PackageNotFoundError:
     __version__ = "0.0.0"
 
 
-def getLogger(module_name="subscript"):
+def getLogger(module_name: str = "subscript") -> logging.Logger:
     """Provides a unified logger for subscript scripts.
 
     Scripts in subscript are encouraged to use logging.info() instead of
@@ -40,7 +40,7 @@ def getLogger(module_name="subscript"):
     if not module_name:
         return getLogger("subscript")
 
-    compressed_name = []
+    compressed_name: list[str] = []
     for elem in module_name.split("."):
         if len(compressed_name) == 0 or elem != compressed_name[-1]:
             compressed_name.append(elem)

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/check_swatinit/pillarmodel.py

@@ -34,7 +34,7 @@ class PillarModel:
         filleps: str = "FILLEPS",
         rptrst: str = "ALLPROPS",
         unifout: str = "UNIFOUT",
-    ):
+    ) -> None:
         """Set up a reservoir grid and dynamic model that can be
         exported as an Eclipse deck.
 

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/convert_grid_format/convert_grid_format.py

@@ -4,6 +4,7 @@ import argparse
 import logging
 import os
 import sys
+from collections.abc import Sequence
 from pathlib import Path
 
 import xtgeo
@@ -88,7 +89,7 @@ def get_parser() -> argparse.ArgumentParser:
     return parser
 
 
-def _do_parse_args(args):
+def _do_parse_args(args: Sequence[str] | None) -> argparse.Namespace:
     """Parse command line arguments"""
 
     if args is None:
@@ -96,14 +97,12 @@ def _do_parse_args(args):
 
     parser = get_parser()
 
-    args = parser.parse_args(args)
-
     if len(sys.argv[1:]) < 2:
         parser.print_help()
         print("QUIT")
         sys.exit(0)
 
-    return args
+    return parser.parse_args(args)
 
 
 def _convert_ecl2roff(
@@ -182,23 +181,28 @@ def _convert_ecl2roff(
             raise SystemExit("Invalid grid extention")
 
 
-def main(args=None) -> None:
+def main(args: Sequence[str] | None = None) -> None:
     """Entry-point"""
 
     XTGeoDialog.print_xtgeo_header(APPNAME, __version__)
 
-    args = _do_parse_args(args)
+    parsed_args = _do_parse_args(args)
 
-    logger.info(args)
+    logger.info(parsed_args)
 
-    if args.conversion not in set(CONVERSIONS):
+    if parsed_args.conversion not in set(CONVERSIONS):
         raise ValueError(
-            f"Illegal conversion <{args.conversion}>. Allowed are: {CONVERSIONS}"
+            f"Illegal conversion <{parsed_args.conversion}>. Allowed are: {CONVERSIONS}"
         )
 
     xtg.say("Running conversion...")
     _convert_ecl2roff(
-        args.infile, args.mode, args.outfile, args.stdfmu, args.propnames, args.dates
+        parsed_args.infile,
+        parsed_args.mode,
+        parsed_args.outfile,
+        parsed_args.stdfmu,
+        parsed_args.propnames,
+        parsed_args.dates,
     )
 
 

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/create_date_files/create_date_files.py

@@ -66,7 +66,7 @@ def get_parser() -> argparse.ArgumentParser:
     return parser
 
 
-def is_iso_date_item(item: Any) -> bool:
+def is_iso_date_item(item: Any) -> bool:  # noqa: ANN401
     """
     Return True if item is:
     - a datetime.date or datetime.datetime, OR

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/csv2ofmvol/csv2ofmvol.py

@@ -321,7 +321,7 @@ def csv2ofmvol_main(csvfilepatterns: list[str], output: str) -> bool:
     return True
 
 
-def main():
+def main() -> None:
     """Entry point if called from command line"""
     args = get_parser().parse_args()
 

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/csv_merge/csv_merge.py

@@ -5,6 +5,7 @@ import logging
 import os
 import re
 import sys
+from typing import Any
 
 import ert
 import pandas as pd
@@ -59,15 +60,15 @@ class CustomFormatter(
 class CsvMerge(ert.ErtScript):
     """A class with a run() function that can be registered as an ERT plugin"""
 
-    def run(self, *args):
+    def run(self, *args: Any) -> None:  # noqa: ANN401
         """Parse with a simplified command line parser, for ERT only,
         call csv_merge_main()"""
         parser = get_ertwf_parser()
-        args = parser.parse_args(args)
+        parsed_args = parser.parse_args(args)
         logger.setLevel(logging.INFO)
-        globbedfiles = glob_patterns(args.csvfiles)
+        globbedfiles = glob_patterns(parsed_args.csvfiles)
         csv_merge_main(
-            csvfiles=globbedfiles, output=args.output, memoryconservative=True
+            csvfiles=globbedfiles, output=parsed_args.output, memoryconservative=True
         )
 
 
@@ -319,7 +320,7 @@ def csv_merge_main(
 
 
 @ert.plugin(name="subscript")
-def legacy_ertscript_workflow(config):
+def legacy_ertscript_workflow(config: ert.WorkflowConfigs) -> None:
     """Hook the CsvMerge class into ERT with the name CSV_MERGE,
     and inject documentation"""
     workflow = config.add_workflow(CsvMerge, "CSV_MERGE")

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/csv_stack/csv_stack.py

@@ -6,7 +6,7 @@ import logging
 import re
 import sys
 from re import Pattern
-from typing import cast
+from typing import Any, cast
 
 import ert
 import pandas as pd
@@ -90,12 +90,12 @@ class CsvStack(ert.ErtScript):
     """A class with a run() function that can be registered as an ERT plugin,
     to be used as an ERT workflow (wrapping the command line utility)"""
 
-    def run(self, *args):
+    def run(self, *args: Any) -> None:  # noqa: ANN401
         """Parse with a simplified command line parser, for ERT only,
         calling csv_stack_main()"""
         parser = get_parser()
-        args = parser.parse_args(args)
-        csv_stack_main(args, support_magics=False)
+        parsed_args = parser.parse_args(args)
+        csv_stack_main(parsed_args, support_magics=False)
 
 
 def get_parser() -> argparse.ArgumentParser:
@@ -323,7 +323,7 @@ def csv_stack(
 
 
 @ert.plugin(name="subscript")
-def legacy_ertscript_workflow(config) -> None:
+def legacy_ertscript_workflow(config: ert.WorkflowConfigs) -> None:
     """Hook the CsvStack class into ERT with the name CSV_STACK,
     and inject documentation"""
     workflow = config.add_workflow(CsvStack, "CSV_STACK")

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/eclcompress/eclcompress.py

@@ -429,7 +429,7 @@ def parse_wildcardfile(filename: str) -> list[str]:
     return list(filter(len, lines))
 
 
-def main():
+def main() -> None:
     """Wrapper for the function main_eclcompress, parsing command line arguments"""
     parser = get_parser()
     args = parser.parse_args()

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/ecldiff2roff/ecldiff2roff.py

@@ -187,7 +187,7 @@ def ecldiff2roff_main(
         diffprop.to_file(filename, name=diffpropname)
 
 
-def main():
+def main() -> None:
     """Main function when called as a command line application.
 
     Will get arguments from command line, and wrap around ecldiff2roff_main().

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/fmuobs/fmuobs.py

@@ -7,6 +7,7 @@ import os
 import signal
 import sys
 from pathlib import Path
+from typing import Any
 
 import ert
 import pandas as pd
@@ -300,8 +301,8 @@ def fmuobs(
     verbose: bool = False,
     debug: bool = False,
     starttime: str | None = None,
-    includedir: bool | None = None,
-):
+    includedir: str | None = None,
+) -> None:
     """Alternative to main() with named arguments"""
     if verbose or debug:
         if __MAGIC_STDOUT__ in (csv, yml, ertobs):
@@ -438,7 +439,7 @@ class FmuObs(ert.ErtScript):
         interference with the ERT comment characters "--".
     """
 
-    def run(self, *args):
+    def run(self, *args: Any) -> None:  # noqa: ANN401
         """Pass the ERT workflow arguments on to the same parser as the command
         line."""
         parser = get_parser()
@@ -447,7 +448,7 @@ class FmuObs(ert.ErtScript):
 
 
 @ert.plugin(name="subscript")
-def legacy_ertscript_workflow(config):
+def legacy_ertscript_workflow(config: ert.WorkflowConfigs) -> None:
     """A hook for usage of this script in an ERT workflow,
     using the legacy hook format."""
     workflow = config.add_workflow(FmuObs, "FMUOBS")

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/fmuobs/parsers.py

@@ -192,7 +192,7 @@ def filter_comments(input_str: str, comment_identifier: str = "--") -> str:
     return "\n".join(filter(len, _lines))
 
 
-def fix_dtype(value):
+def fix_dtype(value: str) -> int | float | datetime.datetime | str:
     """Guess the correct datatype for an incoming value.
 
     If parseable as float, return as integer if it is, return float if not.
@@ -371,7 +371,9 @@ def flatten_observation_unit(
     return obs_subunits
 
 
-def ertobs2df(input_str: str, cwd=".", starttime: str | None = None) -> pd.DataFrame:
+def ertobs2df(
+    input_str: str, cwd: str = ".", starttime: str | None = None
+) -> pd.DataFrame:
     """Parse a string with ERT observations and convert into
     the internal dataframe format.
 
@@ -417,7 +419,9 @@ def ertobs2df(input_str: str, cwd=".", starttime: str | None = None) -> pd.DataF
     return compute_date_from_days(pd.DataFrame(obs_list), starttime)
 
 
-def compute_date_from_days(dframe: pd.DataFrame, starttime: str | None = None):
+def compute_date_from_days(
+    dframe: pd.DataFrame, starttime: str | None = None
+) -> pd.DataFrame:
     """Fill in DATE cells in a dataframe computed from
     a given starttime and data in DAYS cells.
 

{subscript-1.14.4 → subscript-1.14.5}/src/subscript/fmuobs/util.py

@@ -1,5 +1,7 @@
 """Small utility functions used by fmuobs, parsers and/or writers"""
 
+from typing import Any
+
 # Used in yaml file
 CLASS_SHORTNAME = {
     "SUMMARY_OBSERVATION": "smry",
@@ -14,11 +16,11 @@ ERT_ISO_DATE_FORMAT = "%Y-%m-%d"
 ERT_ALT_DATE_FORMAT = "%d.%m.%Y"  # Not found in doc, but supported by ERT
 
 
-def lowercase_dictkeys(some_dict):
+def lowercase_dictkeys(some_dict: dict[str, Any]) -> dict[str, Any]:
     """Convert all keys in a dictionary to lower-case"""
     return {key.lower(): value for key, value in some_dict.items()}
 
 
-def uppercase_dictkeys(some_dict):
+def uppercase_dictkeys(some_dict: dict[str, Any]) -> dict[str, Any]:
     """Convert all keys in a dictionary to upper-case"""
     return {key.upper(): value for key, value in some_dict.items()}