Add warning to ip_and_q if src_z!=rec_z (#238)

Author: prisae

CHANGELOG.rst

@@ -10,6 +10,13 @@ v2.5.x
 """"""
 
 
+*latest*
+--------
+
+- Modelling routines: Add warning to ``ip_and_q`` if ``src_z!=rec_z``; not
+  thoroughly tested.
+
+
 v2.5.0 In-phase and quadrature
 ------------------------------
 

CREDITS.rst

@@ -67,3 +67,4 @@ certainly incomplete list (get in touch if you think you should appear here):
 - `María Carrizo Mascarell <https://github.com/mariacarrizo>`_
 - `Wouter Deleersnyder <https://github.com/WouterDls>`_
 - `Lukas Aigner <https://github.com/aignerlukas>`_
+- `Jan Thorbecke <https://github.com/JanThorbecke>`_

empymod/model.py

@@ -1786,6 +1786,10 @@ def ip_and_q(**kwargs):
     This function is only implemented for frequency-domain data of magnetic
     sources and receivers.
 
+    Warning: Only the case where source and receiver are at the same height has
+    been tested; if you encounter any issues with other configurations, please
+    let us know!
+
 
     Parameters
     ----------
@@ -1819,6 +1823,12 @@ def ip_and_q(**kwargs):
     if kwargs.get('signal', None) is not None:
         raise ValueError("Only implemented for frequency domain.")
 
+    # Warning that it has not been thoroughly tested.
+    verb = kwargs.get('verb', 2)
+    if verb > 0 and not np.allclose(kwargs['src'][2], kwargs['rec'][2]):
+        print("* WARNING :: `src_z != rec_z`: has not been tested; "
+              "please report back any issues you might encounter.")
+
     # Get or set scale
     scale = kwargs.pop('scale', 1e3)
 

tests/test_model.py

@@ -1073,7 +1073,7 @@ def test_dipole_k():
     assert_allclose(w_res1, np.zeros(res['PJ1'].shape, dtype=np.complex128))
 
 
-def test_ip_and_q():
+def test_ip_and_q(capsys):
     # Very simple tests; the function is only a wrapper, so we just test
     # the functionality.
 
@@ -1120,6 +1120,11 @@ def test_ip_and_q():
     assert_allclose(IP3, 0.0)
     assert_allclose(Q3, 0.0)
 
+    _, _ = capsys.readouterr()
+    _, _ = model.ip_and_q(**model1, **{**system, 'src': [0, 0, 0]})
+    out, _ = capsys.readouterr()
+    assert 'has not been tested' in out
+
 
 def test_fem():
     # Just ensure functionality stays the same, with one example.