More updates to logging and handling exceptions.

user_libs/AustinManWoman/head_only_h5.py

@@ -1,8 +1,12 @@
 import argparse
+import logging
 import os
 
 import h5py
 
+logger = logging.getLogger(__name__)
+
+
 # Parse command line arguments
 parser = argparse.ArgumentParser(description='Writes a HDF5 file of AustinMan or AustinWoman head only.', usage='python head_only_hdf5 filename')
 parser.add_argument('filename', help='name and path to (HDF5) file containing AustinMan or AustinWoman model')
@@ -16,7 +20,7 @@ data = f['/data'][:, :, :]
 # Define head as last 1/8 of total body height
 nzhead = 7 * int(data.shape[2] / 8)
 
-print('Dimensions of head model: {:g} x {:g} x {:g} cells'.format(data.shape[0], data.shape[1], data.shape[2] - nzhead))
+logger.info(f'Dimensions of head model: {data.shape[0]:g} x {data.shape[1]:g} x {data.shape[2] - nzhead:g} cells')
 
 # Write HDF5 file
 headfile = os.path.splitext(args.filename)[0] + '_head.h5'

user_libs/antenna_patterns/initial_save.py

@@ -6,6 +6,7 @@
 # Please use the attribution at http://dx.doi.org/10.1016/j.sigpro.2016.04.010
 
 import argparse
+import logging
 import os
 import sys
 
@@ -14,6 +15,9 @@ import h5py
 import matplotlib.pyplot as plt
 import numpy as np
 
+logger = logging.getLogger(__name__)
+
+
 # Parse command line arguments
 parser = argparse.ArgumentParser(description='Calculate and store (in a Numpy file) field patterns from a simulation with receivers positioned in circles around an antenna.', usage='cd gprMax; python -m user_libs.antenna_patterns.initial_save outputfile')
 parser.add_argument('outputfile', help='name of gprMax output file including path')
@@ -58,13 +62,13 @@ if epsr:
     wavelength = v1 / f
 
 # Print some useful information
-print('Centre frequency: {} GHz'.format(f / 1e9))
+logger.info('Centre frequency: {} GHz'.format(f / 1e9))
 if epsr:
-    print('Critical angle for Er {} is {} degrees'.format(epsr, thetac))
-    print('Wavelength: {:.3f} m'.format(wavelength))
-    print('Observation distance(s) from {:.3f} m ({:.1f} wavelengths) to {:.3f} m ({:.1f} wavelengths)'.format(radii[0], radii[0] / wavelength, radii[-1], radii[-1] / wavelength))
-    print('Theoretical boundary between reactive & radiating near-field (0.62*sqrt((D^3/wavelength): {:.3f} m'.format(0.62 * np.sqrt((D**3) / wavelength)))
-    print('Theoretical boundary between radiating near-field & far-field (2*D^2/wavelength): {:.3f} m'.format((2 * D**2) / wavelength))
+    logger.info('Critical angle for Er {} is {} degrees'.format(epsr, thetac))
+    logger.info('Wavelength: {:.3f} m'.format(wavelength))
+    logger.info('Observation distance(s) from {:.3f} m ({:.1f} wavelengths) to {:.3f} m ({:.1f} wavelengths)'.format(radii[0], radii[0] / wavelength, radii[-1], radii[-1] / wavelength))
+    logger.info('Theoretical boundary between reactive & radiating near-field (0.62*sqrt((D^3/wavelength): {:.3f} m'.format(0.62 * np.sqrt((D**3) / wavelength)))
+    logger.info('Theoretical boundary between radiating near-field & far-field (2*D^2/wavelength): {:.3f} m'.format((2 * D**2) / wavelength))
 
 # Load text file with coordinates of pattern origin
 origin = np.loadtxt(os.path.splitext(outputfile)[0] + '_rxsorigin.txt')
@@ -176,4 +180,4 @@ for radius in range(0, len(radii)):
 
 # Save pattern to numpy file
 np.save(os.path.splitext(outputfile)[0], patternsave)
-print('Written Numpy file: {}.npy'.format(os.path.splitext(outputfile)[0]))
+logger.info('Written Numpy file: {}.npy'.format(os.path.splitext(outputfile)[0]))

user_libs/antenna_patterns/plot_fields.py

@@ -6,6 +6,7 @@
 # Please use the attribution at http://dx.doi.org/10.1016/j.sigpro.2016.04.010
 
 import argparse
+import logging
 import os
 import sys
 
@@ -13,6 +14,9 @@ import gprMax.config as config
 import matplotlib.pyplot as plt
 import numpy as np
 
+logger = logging.getLogger(__name__)
+
+
 # Parse command line arguments
 parser = argparse.ArgumentParser(description='Plot field patterns from a simulation with receivers positioned in circles around an antenna. This module should be used after the field pattern data has been processed and stored using the initial_save.py module.', usage='cd gprMax; python -m user_libs.antenna_patterns.plot_fields numpyfile')
 parser.add_argument('numpyfile', help='name of numpy file including path')
@@ -55,13 +59,13 @@ if epsr:
     wavelength = v1 / f
 
 # Print some useful information
-print('Centre frequency: {} GHz'.format(f / 1e9))
+logger.info('Centre frequency: {} GHz'.format(f / 1e9))
 if epsr:
-    print('Critical angle for Er {} is {} degrees'.format(epsr, thetac))
-    print('Wavelength: {:.3f} m'.format(wavelength))
-    print('Observation distance(s) from {:.3f} m ({:.1f} wavelengths) to {:.3f} m ({:.1f} wavelengths)'.format(radii[0], radii[0] / wavelength, radii[-1], radii[-1] / wavelength))
-    print('Theoretical boundary between reactive & radiating near-field (0.62*sqrt((D^3/wavelength): {:.3f} m'.format(0.62 * np.sqrt((D**3) / wavelength)))
-    print('Theoretical boundary between radiating near-field & far-field (2*D^2/wavelength): {:.3f} m'.format((2 * D**2) / wavelength))
+    logger.info('Critical angle for Er {} is {} degrees'.format(epsr, thetac))
+    logger.info('Wavelength: {:.3f} m'.format(wavelength))
+    logger.info('Observation distance(s) from {:.3f} m ({:.1f} wavelengths) to {:.3f} m ({:.1f} wavelengths)'.format(radii[0], radii[0] / wavelength, radii[-1], radii[-1] / wavelength))
+    logger.info('Theoretical boundary between reactive & radiating near-field (0.62*sqrt((D^3/wavelength): {:.3f} m'.format(0.62 * np.sqrt((D**3) / wavelength)))
+    logger.info('Theoretical boundary between radiating near-field & far-field (2*D^2/wavelength): {:.3f} m'.format((2 * D**2) / wavelength))
 
 # Setup figure
 fig = plt.figure(num=args.numpyfile, figsize=(8, 8), facecolor='w', edgecolor='w')

user_libs/antennas/GSSI.py

@@ -5,8 +5,11 @@
 #
 # Please use the attribution at http://dx.doi.org/10.1190/1.3548506
 
+import logging
+
 import gprMax
-from gprMax.exceptions import CmdInputError
+
+logger = logging.getLogger(__name__)
 
 
 def antenna_like_GSSI_1500(x, y, z, resolution=0.001):
@@ -59,7 +62,8 @@ def antenna_like_GSSI_1500(x, y, z, resolution=0.001):
         patchheight = 0.016
         tx = x + 0.114, y + 0.052, z + skidthickness
     else:
-        raise CmdInputError('This antenna module can only be used with a spatial discretisation of 1mm or 2mm')
+        logger.exception('This antenna module can only be used with a spatial discretisation of 1mm or 2mm')
+        raise ValueError
 
     # Specify optimisation state of antenna model
     optstate = ['WarrenThesis', 'DebyeAbsorber', 'GiannakisPaper']
@@ -367,7 +371,8 @@ def antenna_like_GSSI_400(x, y, z, resolution=0.001):
         metalboxheight = 0.088
         tx = x + 0.01 + 0.004 + 0.056, y + casethickness + 0.005 + 0.143 - 0.002, z + skidthickness
     else:
-        raise CmdInputError('This antenna module can only be used with a spatial discretisation of 0.5mm, 1mm, 2mm')
+        logger.exception('This antenna module can only be used with a spatial discretisation of 0.5mm, 1mm, 2mm')
+        raise ValueError
 
     # Material definitions
     absorber = gprMax.Material(er=absorberEr, se=absorbersig, mr=1, sm=0, id='absorber')

user_libs/antennas/MALA.py

@@ -5,8 +5,11 @@
 #
 # Please use the attribution at http://dx.doi.org/10.1190/1.3548506
 
+import logging
+
 import gprMax
-from gprMax.exceptions import CmdInputError
+
+logger = logging.getLogger(__name__)
 
 
 def antenna_like_MALA_1200(x, y, z, resolution=0.001):
@@ -66,7 +69,8 @@ def antenna_like_MALA_1200(x, y, z, resolution=0.001):
         bowtieheight = 0.024
         tx = x + 0.062, y + 0.052, z + skidthickness
     else:
-        raise CmdInputError('This antenna module can only be used with a spatial resolution of 1mm or 2mm')
+        logger.exception('This antenna module can only be used with a spatial resolution of 1mm or 2mm')
+        raise ValueError
 
     # SMD resistors - 3 on each Tx & Rx bowtie arm
     txres = 470  # Ohms