subscript 1.12.0__tar.gz → 1.13.0__tar.gz

{subscript-1.12.0 → subscript-1.13.0}/.github/workflows/codecov.yml

@@ -13,7 +13,7 @@ jobs:
         os: [ubuntu-latest]
     env:
       OS: ${{ matrix.os }}
-      PYTHON: '3.8'
+      PYTHON: '3.12'
 
     steps:
 
@@ -27,7 +27,7 @@ jobs:
     - name: Setup Python
       uses: actions/setup-python@v5
       with:
-        python-version: 3.8
+        python-version: 3.12
 
     - name: Install OPM-flow and ResInsight (for testing)
       run: |

{subscript-1.12.0 → subscript-1.13.0}/.github/workflows/publish.yml

@@ -20,10 +20,10 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: 3.12
 
       - name: Install build dependencies
         run: |

{subscript-1.12.0 → subscript-1.13.0}/.github/workflows/subscript.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
 
@@ -91,7 +91,7 @@ jobs:
         run: sphinx-build -b html docs build/docs/html
 
       - name: Update GitHub pages
-        if: github.repository_owner == 'equinor' && github.ref == 'refs/heads/main' && matrix.python-version == '3.8'
+        if: github.repository_owner == 'equinor' && github.ref == 'refs/heads/main' && matrix.python-version == '3.12'
         run: |
           cp -R ./build/docs/html ../html
 

{subscript-1.12.0 → subscript-1.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: subscript
-Version: 1.12.0
+Version: 1.13.0
 Summary: Equinor's collection of subsurface reservoir modelling scripts
 Author-email: Equinor <rnyb@equinor.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -689,13 +689,13 @@ Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Utilities
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Natural Language :: English
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: resdata
@@ -704,7 +704,7 @@ Requires-Dist: ert>=10.2.0b13
 Requires-Dist: fmu-tools
 Requires-Dist: grid3d_maps
 Requires-Dist: matplotlib
-Requires-Dist: numpy<2
+Requires-Dist: numpy
 Requires-Dist: opm>=2023.04
 Requires-Dist: pandas
 Requires-Dist: pyscal
@@ -722,7 +722,7 @@ Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
 Requires-Dist: pytest-mock; extra == "tests"
 Requires-Dist: pytest-xdist; extra == "tests"
-Requires-Dist: PyQt5-sip<12.16.0; python_version == "3.8" and extra == "tests"
+Requires-Dist: PyQt5-sip; extra == "tests"
 Requires-Dist: rstcheck; extra == "tests"
 Requires-Dist: rstcheck-core; extra == "tests"
 Requires-Dist: ruff; extra == "tests"
@@ -737,12 +737,13 @@ Requires-Dist: sphinx-autodoc-typehints<2.4; 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/master/graph/badge.svg)](https://codecov.io/gh/equinor/subscript)
-![Python Version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11-blue.svg)
+![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12-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-1.12.0 → subscript-1.13.0}/README.md

@@ -2,7 +2,7 @@
 
 [![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/master/graph/badge.svg)](https://codecov.io/gh/equinor/subscript)
-![Python Version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11-blue.svg)
+![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12-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-1.12.0 → subscript-1.13.0}/pyproject.toml

@@ -13,7 +13,7 @@ write_to = "src/subscript/version.py"
 name = "subscript"
 description = "Equinor's collection of subsurface reservoir modelling scripts"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = { file = "LICENSE" }
 authors = [
     { name = "Equinor", email = "rnyb@equinor.com" },
@@ -27,10 +27,10 @@ classifiers = [
     "Topic :: Software Development :: Libraries",
     "Topic :: Utilities",
     "Operating System :: POSIX :: Linux",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Natural Language :: English",
     "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
 ]
@@ -42,7 +42,7 @@ dependencies = [
     "fmu-tools",
     "grid3d_maps",
     "matplotlib",
-    "numpy<2",
+    "numpy",
     "opm>=2023.04",
     "pandas",
     "pyscal",
@@ -63,7 +63,7 @@ tests = [
     "pytest-cov",
     "pytest-mock",
     "pytest-xdist",
-    "PyQt5-sip<12.16.0; python_version == '3.8'",
+    "PyQt5-sip",
     "rstcheck",
     "rstcheck-core",
     "ruff",
@@ -121,7 +121,7 @@ field_statistics = "subscript.field_statistics.field_statistics:main"
 
 
 [project.entry-points.ert]
-subscript_jobs = "subscript.hook_implementations.jobs"
+subscript_fmsteps = "subscript.hook_implementations.forward_model_steps"
 CsvMerge = "subscript.csv_merge.csv_merge"
 CsvStack = "subscript.csv_stack.csv_stack"
 FmuObs = "subscript.fmuobs.fmuobs"

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/casegen_upcars/casegen_upcars.py

@@ -10,29 +10,6 @@ from subscript.casegen_upcars.model import Model
 from subscript.casegen_upcars.udf import TERMINALCOLORS, conversion, flatten, listify
 from subscript.casegen_upcars.udf_arg_parser import fill_parser
 
-DESCRIPTION = """casegen_upcars is script to create conceptual model
-based on sugar-cube representation of fracture.
-
-It has capability to:
-
-- simple geometric: tilting, hull and dome shape
-- Layers heterogeneity (streaks)
-- multple throws (vertical shifting in any part of the model)
-- vugs distribution: random, near fracture and near streak
-- etc. Check wiki for more details:
-  https://wiki.equinor.com/wiki/index.php/UpCaRs_Upscaling_casegen"""
-
-CATEGORY = "modelling.reservoir"
-
-EXAMPLES = """
-.. code-block:: console
-
-  DEFINE <CASEGEN_CONFIG_FILE>      <RUNPATH>/model.yaml
-  DEFINE <CASEGEN_ECLIPSE_TEMPLATE> <CONFIG_PATH>/../input/config/eclipse.tmpl
-  FORWARD_MODEL CASEGEN_UPCARS(<CONFIG>=<CASEGEN_CONFIG_FILE>, <ECLIPSE_TEMPLATE>=<CASEGEN_ECLIPSE_TEMPLATE>, <ECLIPSE_OUTPUT>=<ECLIPSE_NAME>-<IENS>)
-
-"""  # noqa
-
 logger = getLogger(__name__)
 
 

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/check_swatinit/check_swatinit.py

@@ -35,18 +35,6 @@ QC_FLAGS = [
     __WATER__,
 ]
 
-DESCRIPTION = "QC tool for SWATINIT vs SWAT in Eclipse runs"
-
-CATEGORY = "utility.eclipse"
-
-EXAMPLES = """
-.. code-block:: console
-
-  FORWARD_MODEL CHECK_SWATINIT(<DATAFILE>=<ECLBASE>, <OUTPUT>=check_swatinit.csv)
-
-where ``ECLBASE`` is already defined in your ERT config.
-"""
-
 
 def main() -> None:
     """Executed when called from the command line.
@@ -667,7 +655,9 @@ def augment_grid_frame_qc_vectors(grid_df: pd.DataFrame) -> pd.DataFrame:
 
 def get_parser() -> argparse.ArgumentParser:
     """Construct a command line argument parser"""
-    parser = argparse.ArgumentParser(description=DESCRIPTION)
+    parser = argparse.ArgumentParser(
+        description="QC tool for SWATINIT vs SWAT in Eclipse runs"
+    )
     parser.add_argument(
         "DATAFILE",
         help=(

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/csv2ofmvol/csv2ofmvol.py

@@ -14,8 +14,6 @@ logger = subscriptlogger(__name__)
 
 DESCRIPTION = "Convert CSV files with production data to OFM vol-format"
 
-CATEGORY = "modelling.production"
-
 EPILOG = """The indented usage is to process CSV files outputted from the pyPDM
 library (possibly from the script 'export_production_data') and then
 convert this back to OFM (OilField Manager) "vol"-format, which gives

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/csv_merge/csv_merge.py

@@ -44,6 +44,10 @@ runs::
 """  # noqa
 
 
+class NoDataError(Exception):
+    pass
+
+
 class CustomFormatter(
     argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionHelpFormatter
 ):
@@ -260,13 +264,16 @@ def main() -> None:
     if args.debug:
         logger.setLevel(logging.DEBUG)
 
-    csv_merge_main(
-        csvfiles=args.csvfiles,
-        output=args.output,
-        filecolumn=args.filecolumn,
-        memoryconservative=args.memoryconservative,
-        dropconstantcolumns=args.dropconstantcolumns,
-    )
+    try:
+        csv_merge_main(
+            csvfiles=args.csvfiles,
+            output=args.output,
+            filecolumn=args.filecolumn,
+            memoryconservative=args.memoryconservative,
+            dropconstantcolumns=args.dropconstantcolumns,
+        )
+    except NoDataError:
+        sys.exit(1)
 
 
 def csv_merge_main(
@@ -303,8 +310,8 @@ def csv_merge_main(
         merged_df.drop(columnstodelete, inplace=True, axis=1)
 
     if merged_df.empty:
-        logger.error("No data to output.")
-        sys.exit(1)
+        logger.error("No data to output")
+        raise NoDataError
 
     logger.info("Final column list: %s", str(merged_df.columns))
 

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/csv_stack/csv_stack.py

@@ -29,14 +29,6 @@ A-1, A-2, or A-3 as values.
 If importing the output CSV into Spotfire, you may then view and filter WOPT and
 friends by wellname, instead of selecting individual columns."""
 
-# The following string is used for the ERT forward model:
-EXAMPLE = """
-Put this in your ERT config::
-
-  FORWARD_MODEL CSV_STACK(<CSVFILE>=stackme.csv, <OUTPUT>=stacked.csv, <OPTION>="--keepminimal")
-
-"""  # noqa
-
 CATEGORY = "utility.transformation"
 
 # The following string is used for the ERT workflow documentation, note
@@ -81,6 +73,10 @@ STACK_LIBRARY = {
 }
 
 
+class ArgumentError(Exception):
+    pass
+
+
 class CustomFormatter(
     argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionHelpFormatter
 ):
@@ -178,7 +174,10 @@ def main() -> None:
     """Function for command line invocation"""
     parser = get_parser()
     args = parser.parse_args()
-    csv_stack_main(args, support_magics=True)
+    try:
+        csv_stack_main(args, support_magics=True)
+    except ArgumentError:
+        sys.exit(1)
 
 
 def csv_stack_main(args: argparse.Namespace, support_magics: bool = False) -> None:
@@ -196,7 +195,7 @@ def csv_stack_main(args: argparse.Namespace, support_magics: bool = False) -> No
         args.output == __MAGIC_STDOUT__ or args.csvfile == __MAGIC_STDIN__
     ):
         logger.error("Can't use stdin/stdout")
-        sys.exit(1)
+        raise ArgumentError("Can't use stdin/stdout")
 
     if args.verbose:
         if args.output == __MAGIC_STDOUT__:
@@ -211,8 +210,8 @@ def csv_stack_main(args: argparse.Namespace, support_magics: bool = False) -> No
         dframe = pd.read_csv(args.csvfile)
 
     if args.split not in STACK_LIBRARY:
-        logger.error("Don't know how to split on %s", str(args.split))
-        sys.exit(1)
+        logger.error(f"Don't know how to split on {args.split}")
+        raise ArgumentError(f"Don't know how to split on {args.split}")
 
     stackargs = STACK_LIBRARY[args.split]
 

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/eclcompress/eclcompress.py

@@ -27,31 +27,6 @@ If called with ``<FILES>``, the argument provided must be a filepath to
 a text file containing a file list to compress.
 """
 
-EXAMPLES = """
-.. code-block:: console
-
-  FORWARD_MODEL ECLCOMPRESS
-
-You can provide your own list of files to compress with the ``<FILES>``
-argument.
-
-.. code-block:: console
-
-  FORWARD_MODEL ECLCOMPRESS(<FILES>=paths_to_compress.txt)
-
-where ``paths_to_compress.txt`` contains a list of files or filepaths to
-compress.
-
-.. code-block:: text
-  :caption: paths_to_compress.txt
-
-  eclipse/include/grid/*
-  eclipse/include/regions/*
-  eclipse/include/props/*
-
-Note that this list of file paths is the default list used when no file is
-provided.
-"""
 
 DEFAULT_FILES_TO_COMPRESS = [
     "eclipse/include/grid/*",
@@ -62,7 +37,6 @@ DEFAULT_FILES_TO_COMPRESS = [
 EPILOG = """
 Default list of files to compress is """ + " ".join(DEFAULT_FILES_TO_COMPRESS)
 
-CATEGORY = "modelling.reservoir"
 
 # The string used here must match what is used as the DEFAULT
 # parameter in the ert joob config. It is not used elsewhere.

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/ecldiff2roff/ecldiff2roff.py

@@ -21,17 +21,6 @@ space-separated dates pr. line, dates either in YYYY-MM-DD format (ISO-8601) or
 YYYYMMDD. Empty lines and lines starting with "--" or "#" are ignored.
 """
 
-CATEGORY = "utility.eclipse"
-
-EXAMPLES = """
-.. code-block:: console
-
-    FORWARD_MODEL ECLDIFF2ROFF(<ECLROOT>=<ECLBASE>, <PROP>=SGAS, <DIFFDATES>=diff_dates.txt <OUTPUT>=share/results/grids/eclgrid)
-
-where ``ECLBASE`` is already defined in your ERT config, pointing to the Eclipse
-basename relative to ``RUNPATH``.
-"""  # noqa
-
 
 class CustomFormatter(
     argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionHelpFormatter

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/field_statistics/field_statistics.py

@@ -319,18 +319,26 @@ GLOBAL_VARIABLES_FILE = "../../fmuconfig/output/global_variables.yml"
 ERTBOX_GRID_PATH = "../../rms/output/aps/ERTBOX.EGRID"
 
 
+class ArgumentFileNotFound(Exception):
+    pass
+
+
 def main():
     """Invocated from the command line, parsing command line arguments"""
     parser = get_parser()
     args = parser.parse_args()
     logger.setLevel(logging.INFO)
-    field_stat(args)
+    try:
+        field_stat(args)
+    except ArgumentFileNotFound:
+        sys.exit(1)
 
 
 def field_stat(args):
     # parse the config file for this script
     if not Path(args.configfile).exists():
-        sys.exit("No such file:" + args.configfile)
+        logger.error(f"No such file: {args.configfile}")
+        raise ArgumentFileNotFound(f"No such file: {args.configfile}")
 
     config_file = args.configfile
     config_dict = read_field_stat_config(config_file)
@@ -338,12 +346,14 @@ def field_stat(args):
 
     # Path to FMU project models ert/model directory (ordinary CONFIG PATH in ERT)
     if not Path(args.ertconfigpath).exists():
-        sys.exit("No such file:" + args.ertconfigpath)
+        logger.error(f"No such file: {args.ertconfigpath}")
+        raise ArgumentFileNotFound(f"No such file: {args.ertconfigpath}")
     ert_config_path = Path(args.ertconfigpath)
 
     # Path to ensemble on SCRATCH disk
     if not Path(args.ensemblepath).exists():
-        sys.exit("No such file:" + args.ensemblepath)
+        logger.error(f"No such file: {args.ensemblepath}")
+        raise ArgumentFileNotFound(f"No such file: {args.ensemblepath}")
     ens_path = Path(args.ensemblepath)
     if not check_if_iterations_exist(ens_path, field_stat):
         # The ensemble realization does not exist for all specified iterations

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/grav_subs_maps/grav_subs_maps.py

@@ -54,23 +54,6 @@ EPILOGUE = """
 
 """
 
-CATEGORY = "modelling.reservoir"
-
-EXAMPLES = """
-.. code-block:: console
-
- FORWARD_MODEL GRAV_SUBS_MAPS(<UNRST_FILE>=<ECLBASE>.UNRST, <GRAVMAPS_CONFIG>=grav_subs_maps.yml)
- FORWARD_MODEL GRAV_SUBS_MAPS(<UNRST_FILE>=<ECLBASE>.UNRST, <GRAVMAPS_CONFIG>=grav_subs_maps.yml, <OUTPUT_DIR>=share/results/maps)
-
-
-where ``ECLBASE`` is already defined in your ERT config, pointing to the flowsimulator
-basename relative to ``RUNPATH``, grav_subs_maps.yml is a YAML file defining
-the inputs and modelling parameters and ``OUTPUT_DIR`` is the path to the output folder.
-If not specified OUTPUT_DIR will be defaulted to "./".
-
-The directory to export maps to must exist.
-"""  # noqa
-
 
 class GravMapsInput(BaseModel):
     diffdates: List[Tuple[date, date]]

{subscript-1.12.0 → subscript-1.13.0}/src/subscript/grav_subs_points/grav_subs_points.py

@@ -27,17 +27,14 @@ DUMMY_YOUNGS = 10
 PREFIX_POINTS = "all"  # calculation is cumulative over all zones
 EXTENSION_POINTS = ".poi"  # extension for points in roxar points format
 
-DESCRIPTION = """
-Modelling gravity change and subsidence based on flow simulation
+DESCRIPTION = """Modelling gravity change and subsidence based on flow simulation
 output (EGRID, INIT and UNRST files) for a list of locations (
 bencmark stations) at seabed.
 
 The script reads flow simulation results and a yaml configuration file
 specifying input and calculation parameters.
 For configuration of the yaml config file, see:
-https://fmu-docs.equinor.com/docs/subscript/scripts/grav_subs_points.html
-
-"""
+https://fmu-docs.equinor.com/docs/subscript/scripts/grav_subs_points.html"""
 
 EPILOGUE = """
 .. code-block:: yaml
@@ -61,32 +58,6 @@ EPILOGUE = """
 """
 
 
-CATEGORY = "modelling.reservoir"
-
-
-EXAMPLES = """
-.. code-block:: console
-
-  FORWARD_MODEL GRAV_SUBS_POINTS(<UNRST_FILE=<ECLBASE>.UNRST, <GRAVPOINTS_CONFIG>=grav_subs_points.yml)
-  FORWARD_MODEL GRAV_SUBS_POINTS(<UNRST_FILE=<ECLBASE>.UNRST, <GRAVPOINTS_CONFIG>=<CONFIG_PATH>/../input/config/grav_subs_points.yml, <OUTPUT_DIR>=share/results/points)
-
-  FORWARD_MODEL GRAV_SUBS_POINTS(<UNRST_FILE=<ECLBASE>.UNRST, <GRAVPOINTS_CONFIG>=grav_subs_points.yml, <EXTENSION_GENDATA>="_10.txt")
-  FORWARD_MODEL GRAV_SUBS_POINTS(<UNRST_FILE=<ECLBASE>.UNRST, <GRAVPOINTS_CONFIG>=grav_subs_points.yml, <PREFIX_GENDATA>="fieldA_")
-
-where ``ECLBASE`` is already defined in your ERT config, pointing to the flowsimulator
-basename relative to ``RUNPATH``, grav_subs_points.yml is a YAML file defining
-the inputs and modelling parameters and ``OUTPUT_DIR`` is the path to the output folder.
-If not specified OUTPUT_DIR will be defaulted to "./".
-``PREFIX_GENDATA`` and ``EXTENSION_GENDATA`` is the file prefix and extension used for
-the output files of type GEN_DATA. The prefix can be used to separate datasets for
-different structures/fields within the dataset and is defaulted to an empty string,
-i.e. no prefix. The extension could include the report step number by defining e.g. "_10.txt",
-but is defaulted without it a report step number, to only ".txt"
-
-The directory to export point files to must exist.
-"""  # noqa
-
-
 class GravPointsInput(BaseModel):
     diffdates: List[Tuple[date, date]]