gimu 0.3.0__tar.gz → 0.4.0__tar.gz

{gimu-0.3.0 → gimu-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gimu
-Version: 0.3.0
+Version: 0.4.0
 Summary: A toolkit and python library for modelling at Geothermal Institute, University of Auckland.
 Project-URL: Documentation, https://github.com/cyeh015/gimu/blob/main/README.md
 Project-URL: Issues, https://github.com/cyeh015/gimu/issues

{gimu-0.3.0 → gimu-0.4.0}/src/gimu/gmf/data.py

@@ -14,7 +14,7 @@ from collections import OrderedDict
 
 class WellData(dict):
     def __init__(self, *args, **kwargs):
-            super().__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     def downhole_temperature(self, date_str):
         """ get direct access to data without fluff """
@@ -75,7 +75,7 @@ class DataJSON:
                 self._cache[well_name] = data
                 return data
 
-        msg = '\n',join([
+        msg = '\n'.join([
             f"Well '{well_name}' not found in any of the data folders:",
             ] + [f"    {f}" for f in self._data_folders])
         raise KeyError(msg)

gimu-0.4.0/src/gimu/gmf/modifier.py

@@ -0,0 +1,129 @@
+""" handle GMF's modifier files that update model inputs with meta- parameters
+
+- reads rocktype JSON and update model input
+- reads upflow JSON and update model input
+"""
+
+import json
+import os
+import sys
+
+def compute_rocktypes(rocktype_json, warn=True):
+    """ compute the derived rocktype properties and update in place
+
+    if warn, will raise exception when rules are not followed:
+        - along modifier >= 1.0
+        - across modifier <= 1.0
+
+    Example entry in rocktype_json:
+    - base rocktype
+        "A0000": {
+          "permeability": [1e-11, 1e-11, 1e-12 ],
+          "porosity": [0.25 ]
+        },
+
+    - fault modified rocktype
+        "AA000": {
+          "base": ["A0000"],
+          "fault direction": [1],
+          "modifier": {
+            "along": [1],
+            "across": [1],
+            "vertical": [1],
+            "porosity": [1]
+          },
+          "permeability": [1e-11, 1e-11, 1e-12],
+          "porosity": [0.25]
+        },
+
+    - fault interesection rocktype
+        "SVU11": {
+          "base": ["S0011"],
+          "modifier": {
+            "k1": [2.5],
+            "k2": [0.4],
+            "k3": [5],
+            "porosity": [1]
+          },
+          "permeability": [2.5000000000000004e-15, 4.0000000000000004e-16, 5.000000000000001e-15],
+          "porosity": [0.1]
+        }
+
+    """
+    for rt_name, rt in rocktype_json.items():
+        if 'base' not in rt:
+            # base rocktype
+            pass
+        else:
+            if 'fault direction' in rt:
+                fault_dir = rt['fault direction'][0]
+                if float(rt['modifier']['along'][0]) < 1.0:
+                    msg = f"Rocktype {rt_name} has fault modifier 'along' < 1.0"
+                    if warn: raise Exception(msg)
+                    else: print("Warning: " + msg)
+                if float(rt['modifier']['across'][0]) > 1.0:
+                    msg = f"Rocktype {rt_name} has fault modifier 'across' > 1.0"
+                    if warn: raise Exception(msg)
+                    else: print("Warning: " + msg)
+                if fault_dir == 1:
+                    k_modifier = [
+                        float(rt['modifier']['along'][0]),
+                        float(rt['modifier']['across'][0]),
+                        float(rt['modifier']['vertical'][0]),
+                    ]
+                elif fault_dir == 2:
+                    k_modifier = [
+                        float(rt['modifier']['across'][0]),
+                        float(rt['modifier']['along'][0]),
+                        float(rt['modifier']['vertical'][0]),
+                    ]
+                else:
+                    raise Exception(f"Fault direction {rt['fault direction'][0]} not 1 or 2 in rocktype {rt_name}")
+            else:
+                k_modifier = [
+                    float(rt['modifier']['k1'][0]),
+                    float(rt['modifier']['k2'][0]),
+                    float(rt['modifier']['k3'][0]),
+                ]
+            # update permeability in place
+            if rt['base'][0] in rocktype_json:
+                rt['permeability'] = [k * m for k, m in zip(
+                    rocktype_json[rt['base'][0]]['permeability'], k_modifier)]
+                rt['porosity'][0] = rocktype_json[rt['base'][0]]['porosity'][0] * rt['modifier']['porosity'][0]
+            else:
+                msg = f"Base rocktype {rt['base'][0]} not found for rocktype {rt_name}"
+                if warn:
+                    raise Exception(msg)
+                else:
+                    print("Warning: " + msg)
+                    rt['error'] = msg
+
+
+def update_waiwera_model_rocktypes(wjson, rtjson, skip_missing=True):
+    """ rtjson is loaded from the GMF modifier _rocktypes.json
+    """
+    for rt in wjson['rock']['types']:
+        if rt['name'] not in rtjson:
+            if skip_missing:
+                print(f"Rocktype {rt['name']} not found in _rocktypes.json... skipped")
+                continue
+            else:
+                raise Exception(f"Rocktype {rt['name']} not found in _rocktypes.json")
+        modifier = rtjson[rt['name']]
+        rt['permeability'] = modifier['permeability']
+        rt['porosity'] = modifier['porosity'][0]
+
+def update_aut2_model_rocktypes(dat, rtjson, skip_missing=True):
+    """ rtjson is loaded from the GMF modifier _rocktypes.json
+    """
+    for rt in dat.grid.rocktypelist:
+        if rt.name not in rtjson:
+            if skip_missing:
+                print(f"Rocktype {rt.name} not found in _rocktypes.json... skipped")
+                continue
+            else:
+                raise Exception(f"Rocktype {rt.name} not found in _rocktypes.json")
+        modifier = rtjson[rt.name]
+        rt.permeability = modifier['permeability']
+        rt.porosity = modifier['porosity'][0]
+