subscript 1.6.2__tar.gz → 1.9.0__tar.gz

{subscript-1.6.2 → subscript-1.9.0}/.github/workflows/codecov.yml

@@ -27,7 +27,6 @@ jobs:
       run: |
         sudo apt-get install software-properties-common
         sudo apt-add-repository ppa:opm/ppa
-        sudo apt-add-repository ppa:opm/testing
         sudo apt-get update
         sudo apt-get install mpi-default-bin
         sudo apt-get install libopm-simulators-bin

{subscript-1.6.2 → subscript-1.9.0}/.github/workflows/subscript.yml

@@ -39,7 +39,6 @@ jobs:
         run: |
           sudo apt-get install software-properties-common
           sudo apt-add-repository ppa:opm/ppa
-          sudo apt-add-repository ppa:opm/testing
           sudo apt-get update
           sudo apt-get install mpi-default-bin
           sudo apt-get install libopm-simulators-bin

{subscript-1.6.2 → subscript-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: subscript
-Version: 1.6.2
+Version: 1.9.0
 Summary: Equinor's collection of subsurface reservoir modelling scripts
 Author-email: Equinor <rnyb@equinor.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -703,6 +703,7 @@ Requires-Dist: res2df
 Requires-Dist: ert
 Requires-Dist: ert>=10.2.0b13
 Requires-Dist: fmu-tools
+Requires-Dist: grid3d_maps
 Requires-Dist: matplotlib
 Requires-Dist: numpy<2
 Requires-Dist: opm>=2023.04
@@ -732,7 +733,7 @@ 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-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"

{subscript-1.6.2 → subscript-1.9.0}/docs/contributing.rst

@@ -86,7 +86,7 @@ view the documentation like so:
 
  .. code-block:: console
 
-  sphinx-build -b html docs build/docs/html
+  sphinx-build -b html docs build/docs/html --fresh-env
   firefox build/docs/html/index.html
 
 

{subscript-1.6.2 → subscript-1.9.0}/docs/overview.rst

@@ -18,6 +18,8 @@ eclcompress               ✅   ✅                 ⛔️
 ecldiff2roff              ✅   ✅                 ⛔️
 fmu_copy_revision         ✅   ⛔️                 ⛔️
 fmuobs                    ✅   ⛔️                 ✅
+grav_subs_maps            ✅   ✅                 ⛔️
+grav_subs_points          ✅   ✅                 ⛔️
 interp_relperm            ✅   ✅                 ⛔️
 merge_rft_ertobs          ✅   ✅                 ⛔️
 merge_unrst_files         ✅   ✅                 ⛔️

subscript-1.9.0/docs/scripts/field_statistics.rst

@@ -0,0 +1,8 @@
+FIELD_STATISTICS
+=================
+
+.. argparse::
+   :module: subscript.field_statistics.field_statistics
+   :func: get_parser
+   :prog: field_statistics
+   

subscript-1.9.0/docs/scripts/grav_subs_maps.rst

@@ -0,0 +1,46 @@
+
+GRAV_SUBS_MAPS
+==============
+
+.. argparse::
+   :module: subscript.grav_subs_maps.grav_subs_maps
+   :func: get_parser
+   :prog: grav_subs_maps
+	
+Include dates
+-------------
+
+Instead of specifying the modelling dates directly in the yaml config file
+it is possible to include them from another yaml file:
+
+.. code-block:: text
+
+  input:
+    diffdates: !include_from global_variables.yml::global.dates.GRAVITY_DIFFDATES
+
+This is an advantage if the dates in the global config is used also for other jobs. In this example the included file looks like this:
+
+.. code-block:: yaml
+
+  # example global config file with dates
+  global:
+    dates:
+      GRAVITY_DIFFDATES:
+      - - 2020-07-01
+        - 2018-01-01
+   
+The output files
+----------------
+
+The output from this job are maps in irap binary format. For each difference date there will be one subsidence map and one or more gravity change maps (depending on which phases are specified to model).
+
+The naming of the output files have been standardised to:
+
+| all--subsidence--yyyymmdd_yyyymmdd.gri
+
+| all--delta_gravity_gas--yyyymmdd_yyyymmdd.gri
+| all--delta_gravity_oil--yyyymmdd_yyyymmdd.gri
+| all--delta_gravity_water--yyyymmdd_yyyymmdd.gri
+| all--delta_gravity_total--yyyymmdd_yyyymmdd.gri
+
+The "all" prefix is indicating that the contributions from all zones is summed.    

subscript-1.9.0/docs/scripts/grav_subs_points.rst

@@ -0,0 +1,75 @@
+GRAV_SUBS_POINTS
+================
+
+.. argparse::
+   :module: subscript.grav_subs_points.grav_subs_points
+   :func: get_parser
+   :prog: grav_subs_points
+
+	  
+Include dates
+-------------
+
+Instead of specifying the modelling dates directly in the yaml config file
+it is possible to include them from another yaml file:
+
+.. code-block:: text
+
+  input:
+    diffdates: !include_from global_variables.yml::global.dates.GRAVITY_DIFFDATES
+
+This is an advantage if the dates in the global config is used also for other jobs. In this example the included file looks like this:
+
+.. code-block:: yaml
+
+  # example global config file with dates
+  global:
+    dates:
+      GRAVITY_DIFFDATES:
+      - - 2020-07-01
+        - 2018-01-01
+
+
+Station coordinates
+-------------------
+
+The file with station coordinates should be on .csv format and contain headers
+as specified in this example:
+
+.. code-block:: text
+
+  bm_id;utmx;utmy;depth;area
+  1;462632.692871;5930050.419434;200.000000;WL
+  2;464438.063965;5932652.277710;200.000000;CH
+  3;462924.737793;5933448.764526;200.000000;CH
+  4;459977.734863;5935121.387695;200.000000;NH
+  5;462247.045000;5934298.281000;200.000000;CH
+  6;461517.610352;5933448.764526;200.000000;CN
+  7;463933.621582;5931643.393677;200.000000;CS
+  8a;463429.180176;5935068.288086;200.000000;EL
+  9b;460561.825684;5936608.163086;200.000000;CH
+  10;460482.177246;5931723.042358;200.000000;WL
+
+| **bm_id**:      Name of the bencmark location.
+| **utmx**:       UTM X for the bencmark location [m]
+| **utmy**:       UTM Y for the bencmark location [m]
+| **depth**:      Seabed depth for benchmark location [m TVD MSL]
+| **area**:       An area identifier that can be used for grouping or labeling in visualisations
+
+
+
+The output files
+----------------
+
+There will be two types of output file from grav_subs_points.
+
+- one column text files of modelled gravity change/subsidence GEN_DATA files that can be used with ert GENERAL_OBSERVATION
+  
+- x,y,z text file that can be used for visualisation.
+
+The ordering of points in these two files will be the same as given in the station coordinates file used as input. It can therefore be a good idea to order the benchmark stations in the station coordinates file in the order you would like to see them in e.g. line plots, for instance sorted by area.
+
+In some cases where the reservoir model covers several structures or fields it can be beneficial to split the modelling for different structures into several files. E.g. for testing in assisted history matching what effect it has if only observations for one of the structures is used as observations compared to both. To facilitate this usage the option to add a prefix to the GEN_DATA file to separate them, using the prefix_gendata option. There is also a possibility to use a different report step and extension than the default ".txt" by using the extension_gendata option. The default is now without any report step, since this is now longer needed in ert. But if defining a report step is needed, an extension like e.g. "_10.txt" could be given. 
+  
+
+  

{subscript-1.6.2 → subscript-1.9.0}/docs/scripts/prtvol2csv.rst

@@ -34,13 +34,15 @@ The script will read numbers from the line with ``CURRENTLY IN PLACE`` in Eclips
   ====================================================================================================================================
 
 
-Additionally, if the Eclipse DATA file includes::
+Additionally, if the Eclipse DATA file includes
+
+.. code-block:: none
 
   RPTSOL
     FIP=2 'FIPRESV' /
 
-the PRT-file will also contain a table with pore volumes pr. phase and pr.
-FIPNUM, which will be added to the exported table.
+the PRT-file will also contain a table with pore volumes per phase and per FIPNUM, 
+which will be added to the exported table. FIPRESV will include reservoir volumes (RM3).
 
 .. code-block:: none
 
@@ -56,6 +58,11 @@ FIPNUM, which will be added to the exported table.
   :       2 :      79481140.:             0.:      79481140.:             0.:             0.:
   ===========================================================================================
 
+If `FIP=3` in RPTSOL, the PRT file will also contain report of in-place volumes for any additional 
+FIP-vectors. Default is to export volumes per FIPNUM, but any FIP-vector can be specified
+using the ``fipname`` option. By using the ``rename2fipnum`` option, the column name would be set to FIPNUM 
+in the csv-file for any FIP-vector, as required by ``webviz-subsurface`` plugin ``VolumetricAnalysis``. 
+This renaming is not needed for ``Webviz-Sumo``. An additional column with the actual FIPNAME is included for information.
 
 
 Region and zone support

{subscript-1.6.2 → subscript-1.9.0}/pyproject.toml

@@ -41,6 +41,7 @@ dependencies = [
     "ert",
     "ert>=10.2.0b13",
     "fmu-tools",
+    "grid3d_maps",
     "matplotlib",
     "numpy<2",
     "opm>=2023.04",
@@ -74,7 +75,7 @@ docs = [
     "autoapi",
     "sphinx",
     "sphinx-argparse",
-    "sphinx-autodoc-typehints",
+    "sphinx-autodoc-typehints<2.4",
     "sphinx-copybutton",
     "sphinx-togglebutton",
     "sphinx_rtd_theme",
@@ -98,6 +99,7 @@ ecldiff2roff = "subscript.ecldiff2roff.ecldiff2roff:main"
 fmu_copy_revision = "subscript.fmu_copy_revision.fmu_copy_revision:main"
 fmuobs = "subscript.fmuobs.fmuobs:main"
 grav_subs_maps = "subscript.grav_subs_maps.grav_subs_maps:main"
+grav_subs_points = "subscript.grav_subs_points.grav_subs_points:main"
 interp_relperm = "subscript.interp_relperm.interp_relperm:main"
 merge_rft_ertobs = "subscript.merge_rft_ertobs.merge_rft_ertobs:main"
 merge_unrst_files = "subscript.merge_unrst_files.merge_unrst_files:main"
@@ -115,6 +117,8 @@ sw_model_utilities = "subscript.sw_model_utilities.sw_model_utilities:main"
 sunsch = "subscript.sunsch.sunsch:main"
 vfp2csv = "subscript.vfp2csv.vfp2csv:main"
 welltest_dpds = "subscript.welltest_dpds.welltest_dpds:main"
+field_statistics = "subscript.field_statistics.field_statistics:main"
+
 
 [project.entry-points.ert]
 subscript_jobs = "subscript.hook_implementations.jobs"
@@ -122,6 +126,7 @@ CsvMerge = "subscript.csv_merge.csv_merge"
 CsvStack = "subscript.csv_stack.csv_stack"
 FmuObs = "subscript.fmuobs.fmuobs"
 Params2Csv = "subscript.params2csv.params2csv"
+FieldStatistics = "subscript.field_statistics.field_statistics"
 
 [tool.setuptools]
 script-files = [

{subscript-1.6.2 → subscript-1.9.0}/src/subscript/check_swatinit/check_swatinit.py

@@ -2,7 +2,7 @@
 
 import argparse
 import sys
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Union
 
 import numpy as np
 import pandas as pd
@@ -473,7 +473,7 @@ def _evaluate_pc(
     swats: List[float],
     scale_vert: List[float],
     swls: List[float],
-    swus: List[float],
+    swus: Union[None, List[float]],
     satfunc: pd.DataFrame,
     sat_name: str = "SW",
     pc_name: str = "PCOW",

subscript-1.9.0/src/subscript/config_jobs/GRAV_SUBS_MAPS

@@ -0,0 +1,9 @@
+EXECUTABLE  grav_subs_maps
+
+DEFAULT  <OUTPUT_DIR> "./"
+
+ARGLIST  "--configfile" <GRAVMAPS_CONFIG> "--outputdir" <OUTPUT_DIR> <UNRST_FILE> 
+
+MIN_ARG  2
+MAX_ARG  3
+ARG_TYPE 0 STRING

subscript-1.9.0/src/subscript/config_jobs/GRAV_SUBS_POINTS

@@ -0,0 +1,13 @@
+EXECUTABLE  grav_subs_points
+
+DEFAULT  <OUTPUT_DIR> "./"
+
+DEFAULT  <PREFIX_GENDATA> ""
+DEFAULT  <EXTENSION_GENDATA> ".txt"
+
+ARGLIST  "--configfile" <GRAVPOINTS_CONFIG> "--outputdir" <OUTPUT_DIR> "--prefix_gendata" <PREFIX_GENDATA> "--extension_gendata" <EXTENSION_GENDATA> <UNRST_FILE> 
+
+MIN_ARG  2
+MAX_ARG  5
+
+ARG_TYPE 0 STRING

{subscript-1.6.2 → subscript-1.9.0}/src/subscript/config_jobs/PRTVOL2CSV

@@ -1,18 +1,18 @@
 EXECUTABLE prtvol2csv
 
-
 DEFAULT <DIR> share/results/volumes
 DEFAULT <OUTPUTFILENAME> simulator_volume_fipnum.csv
-
 DEFAULT <REGIONS> ""
+DEFAULT <FIPNAME> "FIPNUM"
 
 ARG_TYPE 0 STRING
 ARG_TYPE 1 STRING
 ARG_TYPE 2 STRING
 ARG_TYPE 3 STRING
 ARG_TYPE 4 STRING
+ARG_TYPE 5 STRING
 
-ARGLIST "--verbose" "--dir" <DIR> "--outputfilename" <OUTPUTFILENAME> "--yaml" <REGIONS> <DATAFILE>
+ARGLIST "--verbose" "--dir" <DIR> "--outputfilename" <OUTPUTFILENAME> "--yaml" <REGIONS> "--rename2fipnum" "--fipname" <FIPNAME>  <DATAFILE>
 
 MIN_ARG 1
-MAX_ARG 5
+MAX_ARG 6