resqpy 4.8.2__tar.gz → 4.8.4__tar.gz

{resqpy-4.8.2 → resqpy-4.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: resqpy
-Version: 4.8.2
+Version: 4.8.4
 Summary: Python API for working with RESQML models
 Home-page: https://github.com/bp/resqpy
 License: MIT

{resqpy-4.8.2 → resqpy-4.8.4}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "resqpy"
-version = "4.8.2" # Set at build time
+version = "4.8.4" # Set at build time
 description = "Python API for working with RESQML models"
 authors = ["BP"]
 license = "MIT"

{resqpy-4.8.2 → resqpy-4.8.4}/resqpy/__init__.py

@@ -28,6 +28,6 @@
 
 import logging
 
-__version__ = "4.8.2"  # Set at build time
+__version__ = "4.8.4"  # Set at build time
 log = logging.getLogger(__name__)
 log.info(f"Imported resqpy version {__version__}")

{resqpy-4.8.2 → resqpy-4.8.4}/resqpy/model/_hdf5.py

@@ -229,10 +229,12 @@ def _h5_array_element(model,
         shape_tuple = tuple(h5_root[h5_key_pair[1]].shape)
         if required_shape is None:
             required_shape = shape_tuple
+        else:
+            required_shape = tuple(required_shape)
         object.__dict__[array_attribute] = np.zeros(required_shape, dtype = dtype)
         if shape_tuple == required_shape:
             object.__dict__[array_attribute][:] = h5_root[h5_key_pair[1]]
-        elif (len(shape_tuple) == len(required_shape) and ('bool' in str_dtype or 'int8' in str_dtype) and
+        elif (len(shape_tuple) == len(required_shape) and ('bool' in str_dtype or 'uint8' in str_dtype) and
               8 * (shape_tuple[-1] - 1) < required_shape[-1] <= 8 * shape_tuple[-1]):
             a = np.unpackbits(h5_root[h5_key_pair[1]], axis = -1).astype(bool)
             object.__dict__[array_attribute][:] = a[..., :required_shape[-1]]

{resqpy-4.8.2 → resqpy-4.8.4}/resqpy/property/_collection_get_attributes.py

@@ -427,6 +427,8 @@ def _supporting_shape_grid(support, indexable_element, direction):
         shape_list = [support.nk, support.ni]
     elif indexable_element == 'I0':
         shape_list = [support.nk, support.nj]
+    else:
+        raise ValueError(f'unsupported grid indexable element: {indexable_element}')
     return shape_list
 
 
@@ -549,7 +551,7 @@ def _cached_part_array_ref_const_none(collection, part, dtype, model, cached_arr
     # the required shape is required if a bool array may need to be unpacked from bits
     required_shape = None
     str_dtype = str(dtype)
-    if use_pack and ('bool' in str_dtype or 'int8' in str_dtype):
+    if use_pack and ('bool' in str_dtype or 'uint8' in str_dtype):
         required_shape = collection.supporting_shape(indexable_element = collection.indexable_for_part(part),
                                                      direction = _part_direction(collection, part))
 

{resqpy-4.8.2 → resqpy-4.8.4}/resqpy/weights_and_measures/nexus_units.py

@@ -10,10 +10,12 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
         nexus_unit_system (str): one of 'METRIC', 'METKG/CM2', 'METBAR', 'LAB', or 'ENGLISH'
         quantity (str): the RESQML quantity class of interest; currently suppported:
             'length', 'area', 'volume', 'volume per volume', 'permeability rock',
-            'time', 'thermodynamic temperature', 'mass per volume', 'pressure'
-        english_volume_flavour (str, optional): only needed for ENGLISH unit system and volume
-            or volume per volume quantity; one of 'PV', 'OVER PV', 'FVF', 'GOR', or 'saturation';
-            see notes regarding FVF
+            'time', 'thermodynamic temperature', 'mass per volume', 'pressure',
+            'volume per time'
+        english_volume_flavour (str, optional): only needed for ENGLISH unit system and volume,
+            volume per volume, or volume per time quantity; one of 'PV', 'OVER PV', 'FVF', 'GOR',
+            'surface gas rate', or 'saturation'; see notes regarding FVF, also regarding flow
+            rates
 
     returns:
         str: the RESQML uom string for the units required by Nexus
@@ -27,7 +29,8 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
         in the ENHLISH unit system, Nexus expacts gas formation volume factors in bbl / 1000 ft3
         but that is not a valid RESQML uom – this function will return bbl/bbl for ENGLISH FVF;
         also be wary of pore volume units when using the medieval ENGLISH unit system: the OVER
-        keyword expects different units than GRID or recurrent override input
+        keyword expects different units than GRID or recurrent override input; ENGLISH fluid flow
+        rates will be returned as bbl/d unless the flavour is specified as 'surface gas rate'
     """
 
     nexus_unit_system = nexus_unit_system.upper()
@@ -35,7 +38,7 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
     # todo: add other quantities as needed
     assert quantity in [
         'length', 'area', 'volume', 'volume per volume', 'permeability rock', 'rock permeability', 'time',
-        'thermodynamic temperature', 'mass per volume', 'pressure'
+        'thermodynamic temperature', 'mass per volume', 'pressure', 'volume per time'
     ]
     if quantity == 'rock permeability':
         quantity = 'permeability rock'
@@ -48,6 +51,9 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
         elif english_volume_flavour == 'over pv':
             assert quantity == 'volume'
             return 'bbl'  # for static override of pv (Nexus OVER)
+        elif english_volume_flavour == 'surface gas rate':
+            assert quantity == 'volume per time'
+            return '1000 ft3/d'
         assert quantity == 'volume per volume'
         if english_volume_flavour == 'fvf':
             return 'bbl/bbl'
@@ -66,7 +72,8 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
             'time': 'd',
             'thermodynamic temperature': 'degC',
             'mass per volume': 'kg/m3',
-            'pressure': 'kPa'
+            'pressure': 'kPa',
+            'volume per time': 'm3/d'
         },
         'METKG/CM2': {
             'length': 'm',
@@ -77,7 +84,8 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
             'time': 'd',
             'thermodynamic temperature': 'degC',
             'mass per volume': 'kg/m3',
-            'pressure': 'kgf/cm2'
+            'pressure': 'kgf/cm2',
+            'volume per time': 'm3/d'
         },
         'METBAR': {
             'length': 'm',
@@ -88,7 +96,8 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
             'time': 'd',
             'thermodynamic temperature': 'degC',
             'mass per volume': 'kg/m3',
-            'pressure': 'bar'
+            'pressure': 'bar',
+            'volume per time': 'm3/d'
         },
         'LAB': {
             'length': 'cm',
@@ -99,7 +108,8 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
             'time': 'h',
             'thermodynamic temperature': 'degC',
             'mass per volume': 'g/cm3',
-            'pressure': 'psi'
+            'pressure': 'psi',
+            'volume per time': 'cm3/h'
         },
         'ENGLISH': {
             'length': 'ft',
@@ -110,7 +120,8 @@ def nexus_uom_for_quantity(nexus_unit_system, quantity, english_volume_flavour =
             'time': 'd',
             'thermodynamic temperature': 'degF',
             'mass per volume': 'lbm/ft3',
-            'pressure': 'psi'
+            'pressure': 'psi',
+            'volume per time': 'bbl/d'  # surface gas is special case handled above
         }
     }