Merge pull request #99 from equinor/zero_0_case_handling

Zero 0 case handling

changelog.md

@@ -1,3 +1,6 @@
+## 1.8.1
+* Added case handling when zero value is 0
+
 ## 1.8
 * Implemented type hinting
 * Removed warning for geometry factors above 4

pysand/asd.py

@@ -12,11 +12,11 @@ def validate_asd(**kwargs: float) -> bool:
     for i in ['v_m', 'GLR', 'GOR']:
         if i in kwargs:
             if kwargs[i] is None:
-                raise exc.FunctionInputFail('No calculation is done due to missing {}'.format(i))
+                raise exc.FunctionInputFail(f'No calculation is done due to missing {i}')
             if not isinstance(kwargs[i], (float, int, np.integer)):
-                raise exc.FunctionInputFail('{} is not a number'.format(i))
+                raise exc.FunctionInputFail(f'{i} is not a number')
             if not kwargs[i] >= 0:
-                logger.warning('The model has got negative value(s) of {} and returned nan.'.format(i))
+                logger.warning(f'The model has got negative value(s) of {i} and returned nan.')
                 return True
 
 def std_step_clampon(v_m: float, GLR: float) -> float:
@@ -82,7 +82,7 @@ def sand_rate(raw: float, zero: float, step: float, exp: float=1) -> float:
 
     for key, value in {'raw': raw, 'zero': zero, 'step': step, 'exp': exp}.items():
         if value is None:
-            raise exc.FunctionInputFail('No calculation is done due to missing {}'.format(key))
+            raise exc.FunctionInputFail(f'No calculation is done due to missing {key}')
 
     if raw > zero:
         try:
@@ -94,6 +94,10 @@ def sand_rate(raw: float, zero: float, step: float, exp: float=1) -> float:
             if Qs < 0:
                 logger.warning('Negative step. Sand rate set to NaN')
                 Qs = np.nan
+            elif zero == 0:
+                logger.warning('Zero value is 0. Sand rate set to NaN')
+                Qs = np.nan
+
     else:
         Qs = 0
 

pysand/version.py

@@ -1 +1 @@
-__version__ = '1.8'
+__version__ = '1.8.1'

tests/test_asd.py

@@ -77,3 +77,19 @@ def test_sand_rate_None_input():
         kwargs['zero'] = zero
         kwargs['step'] = step
         kwargs['exp'] = exp
+
+def test_zero_zero_input(caplog):
+    raw = 5000
+    zero = 0
+    step = 500
+    exp = 1
+    kwargs = {'raw': raw, 'zero': zero, 'step': step, 'exp': exp}
+
+    kwargs['raw'] = raw
+    kwargs['zero'] = zero
+    kwargs['step'] = step
+    kwargs['exp'] = exp
+
+    with caplog.at_level(logging.WARNING):
+        sand_rate(**kwargs)
+    assert "Zero value is 0. Sand rate set to NaN" in str(caplog.records)