Updated names of some user_libs

docs/source/include_user_libs_antenna_patterns.rst

@@ -1 +1 @@
-.. include:: ../../user_libs/antenna_patterns/docs/README.rst
+.. include:: ../../user_libs/AntennaPatterns/docs/README.rst

tests/experimental/antenna_GSSI_1500_fs/antenna_GSSI_1500_fs.in

@@ -4,7 +4,7 @@
 #time_window: 8E-9
 
 #python:
-from user_libs.antennas import antenna_like_GSSI_1500
+from user_libs.GPRAntennaModels import antenna_like_GSSI_1500
 antenna_like_GSSI_1500(0.125, 0.094, 0.100)
 #end_python:
 

tests/experimental/antenna_MALA_1200_fs/antenna_MALA_1200_fs.in

@@ -4,7 +4,7 @@
 #time_window: 6e-9
 
 #python:
-from user_libs.antennas import antenna_like_MALA_1200
+from user_libs.GPRAntennaModels import antenna_like_MALA_1200
 antenna_like_MALA_1200(0.132, 0.095, 0.100)
 #end_python:
 

tests/other_codes/evtk_test.py

@@ -6,7 +6,7 @@
 from pathlib import Path
 import sys
 import gprMax
-from user_libs.antennas.GSSI import antenna_like_GSSI_400
+from user_libs.GPRAntennaModels.GSSI import antenna_like_GSSI_400
 
 import numpy as np
 

tests/other_codes/vs_GprMax_oldCcode/antenna_GSSI_1500_fs/antenna_GSSI_1500_fs.in

@@ -4,7 +4,7 @@
 #time_window: 8E-9
 
 #python:
-from user_libs.antennas import antenna_like_GSSI_1500
+from user_libs.GPRAntennaModels import antenna_like_GSSI_1500
 antenna_like_GSSI_1500(0.125, 0.094, 0.100)
 #end_python:
 

tests/other_codes/vs_GprMax_oldCcode/antenna_MALA_1200_fs/antenna_MALA_1200_fs.in

@@ -4,7 +4,7 @@
 #time_window: 6e-9
 
 #python:
-from user_libs.antennas import antenna_like_MALA_1200
+from user_libs.GPRAntennaModels import antenna_like_MALA_1200
 antenna_like_MALA_1200(0.132, 0.095, 0.100)
 #end_python:
 

user_libs/AntennaPatterns/docs/README.rst

@@ -1,7 +1,7 @@
 User libraries is a sub-package where useful Python modules contributed by users are stored.
 
 ****************
-Antenna patterns
+Antenna Patterns
 ****************
 
 Information
@@ -40,8 +40,8 @@ How to use the package
 
 * Firstly you should familiarise yourself with the example model input file. Edit the input file as desired and run one of the simulations for either E-plane or H-plane patterns.
 * Whilst the simulation is running edit the 'user configurable parameters' sections of the ``initial_save.py`` and ``plot_fields.py`` modules to match the setup of the simulation.
-* Once the simulation has completed, run the ``initial_save.py`` module on the output file, e.g. for the E-plane ``python -m user_libs.antenna_patterns.initial_save user_models/antenna_like_GSSI_1500_patterns_E_Er5.h5``. This will produce a Numpy file containing the field pattern data.
+* Once the simulation has completed, run the ``initial_save.py`` module on the output file, e.g. for the E-plane ``python -m user_libs.AntennaPatterns.initial_save user_models/antenna_like_GSSI_1500_patterns_E_Er5.h5``. This will produce a Numpy file containing the field pattern data.
-* Plot the field pattern data by running the ``plot_fields.py`` module on the Numpy file, e.g. for the E-plane ``python -m user_libs.antenna_patterns.plot_fields user_models/antenna_like_GSSI_1500_patterns_E_Er5.npy``
+* Plot the field pattern data by running the ``plot_fields.py`` module on the Numpy file, e.g. for the E-plane ``python -m user_libs.AntennaPatterns.plot_fields user_models/antenna_like_GSSI_1500_patterns_E_Er5.npy``
 
 .. tip::
 

user_libs/AntennaPatterns/initial_save.py

@@ -19,7 +19,7 @@ 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 = 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.AntennaPatterns.initial_save outputfile')
 parser.add_argument('outputfile', help='name of gprMax output file including path')
 args = parser.parse_args()
 outputfile = args.outputfile

user_libs/AntennaPatterns/plot_fields.py

@@ -18,7 +18,7 @@ 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 = 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.AntennaPatterns.plot_fields numpyfile')
 parser.add_argument('numpyfile', help='name of numpy file including path')
 # parser.add_argument('hertzian', help='name of numpy file including path')
 args = parser.parse_args()

user_libs/GPRAntennasModels/GSSI.py

@@ -303,7 +303,7 @@ def antenna_like_GSSI_1500(x, y, z, resolution=0.001, **kwargs):
 
     elif optstate == 'GiannakisPaper':
         # Optimised custom pulse
-        exc1 = gprMax.ExcitationFile(filepath='user_libs/antennas/GSSI1p5optpulse.txt', 
+        exc1 = gprMax.ExcitationFile(filepath='user_libs/GPRAntennaModels/GSSI1p5optpulse.txt', 
                                      kind='linear', fill_value='extrapolate')
         vs1 = gprMax.VoltageSource(polarisation='y', p1=(tx[0], tx[1], tx[2]), 
                                    resistance=sourceresistance, waveform_id='GSSI1p5optpulse')

user_libs/GPRAntennasModels/docs/README.rst

@@ -50,7 +50,7 @@ To include an antenna model similar to a GSSI 1.5 GHz antenna at a location 0.12
 .. code-block:: none
 
     #python:
-    from user_libs.antennas.GSSI import antenna_like_GSSI_1500
+    from user_libs.GPRAntennaModels.GSSI import antenna_like_GSSI_1500
     antenna_like_GSSI_1500(0.125, 0.094, 0.100, resolution=0.002)
     #end_python:
 

user_libs/landmines/docs/README.rst

@@ -71,7 +71,7 @@ The input file for inserting the PMN landmine, with the lower left corner 10mm f
     #domain: 0.136 0.176 0.070
     #dx_dy_dz: 0.001 0.001 0.001
     #time_window: 5e-9
-    #geometry_objects_read: 0.010 0.010 0.010 ../user_libs/landmines/PMN_1x1x1.h5 ../user_libs/landmines/PMN_materials.txt
+    #geometry_objects_read: 0.010 0.010 0.010 ../user_libs/Landmines/PMN_1x1x1.h5 ../user_libs/Landmines/PMN_materials.txt
     #geometry_view: 0 0 0 0.136 0.176 0.070 0.001 0.001 0.001 landmine_PMN_fs n
 
 For further information on the ``#geometry_objects_read`` see the section on object contruction commands in the :ref:`Input commands section <commands>`.

user_libs/stltovoxel/docs/README.rst

@@ -1,7 +1,7 @@
 User libraries is a sub-package where useful Python modules contributed by users are stored.
 
 **********
-stltovoxel
+STLtoVoxel
 **********
 
 Information
@@ -20,7 +20,7 @@ This package was created as part of the `Google Summer of Code <https://summerof
 Package contents
 ================
 
-* ``stltovoxel.py`` is the main script which should be executed to convert a STL file to a voxelised mesh which is saved as a geometry file in HDF5 format suitable for directly importing into gprMax.
+* ``STLtoVoxel.py`` is the main script which should be executed to convert a STL file to a voxelised mesh which is saved as a geometry file in HDF5 format suitable for directly importing into gprMax.
 * ``examples`` is a folder containing example STL files as well as gprMax input files that can be used to import the resulting HDF5 geometry files.
 * ``convert.py``, ``perimeter.py``, ``slice.py`` are modules adapted from the `stl-to-voxel <https://github.com/cpederkoff/stl-to-voxel>`_ Python library by Christian Pederkoff.
 * ``license.md`` is the license for the `stl-to-voxel <https://github.com/cpederkoff/stl-to-voxel>`_ Python library by Christian Pederkoff.
@@ -43,7 +43,7 @@ To create a voxelised mesh (HDF5 geometry file) from the ubiquitous `Stanford bu
 
 .. code-block:: none
 
-    python -m user_libs.stltovoxel.stltovoxel user_libs/stltovoxel/examples/stl/Stanford_Bunny.stl -matindex 2 -dxdydz 0.001 0.001 0.001
+    python -m user_libs.STLtoVoxel.stltovoxel user_libs/STLtoVoxel/examples/stl/Stanford_Bunny.stl -matindex 2 -dxdydz 0.001 0.001 0.001
 
 Since the number of voxels are 108 x 88 108 and the spatial discretisation chosen is 1mm, the physical dimensions of the Stanford bunny when imported into gprMax will be 0.108 x 0.088 x 0.108mm.
 

user_libs/stltovoxel/stltovoxel.py

@@ -12,7 +12,7 @@ logging.basicConfig(format='%(message)s', level=logging.INFO)
 if __name__ == "__main__":
 
     # Parse command line arguments
-    parser = argparse.ArgumentParser(description='Allows the user to convert a STL files to voxelized mesh.', usage='cd gprMax; python -m user_libs.stltovoxel.stltovoxel stlfilename matindex dx_dy_dz')
+    parser = argparse.ArgumentParser(description='Allows the user to convert a STL files to voxelized mesh.', usage='cd gprMax; python -m user_libs.STLtoVoxel.stltovoxel stlfilename matindex dx_dy_dz')
     parser.add_argument('stlfilename', help='name of STL file to convert including path')
     parser.add_argument('-matindex', type=int, required=True,
                         help='index of material to extract from STL file')

user_models/antenna_like_GSSI_1500_fs.in

@@ -4,7 +4,7 @@
 #time_window: 6e-9
 
 #python:
-from user_libs.antennas.GSSI import antenna_like_GSSI_1500
+from user_libs.GPRAntennaModels.GSSI import antenna_like_GSSI_1500
 gssi_objects = antenna_like_GSSI_1500(0.125, 0.094, 0.100, resolution=0.001)
 for obj in gssi_objects:
     print(obj)

user_models/antenna_like_GSSI_1500_fs.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import gprMax
-from user_libs.antennas.GSSI import antenna_like_GSSI_1500
+from user_libs.GPRAntennaModels.GSSI import antenna_like_GSSI_1500
 
 # File path for output
 fn = Path(__file__)

user_models/antenna_like_GSSI_400_fs.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import gprMax
-from user_libs.antennas.GSSI import antenna_like_GSSI_400
+from user_libs.GPRAntennaModels.GSSI import antenna_like_GSSI_400
 
 # File path for output
 fn = Path(__file__)

user_models/antenna_like_MALA_1200_fs.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import gprMax
-from user_libs.antennas.MALA import antenna_like_MALA_1200
+from user_libs.GPRAntennaModels.MALA import antenna_like_MALA_1200
 
 # File path for output
 fn = Path(__file__)

user_models/sub-gridding/gssi_400_over_fractal_subsurface.py

@@ -6,7 +6,7 @@
 from pathlib import Path
 
 import gprMax
-from user_libs.antennas.GSSI import antenna_like_GSSI_400
+from user_libs.GPRAntennaModels.GSSI import antenna_like_GSSI_400
 
 import numpy as np