diff --git a/docs/source/user_libs_antenna_patterns.rst b/docs/source/user_libs_antenna_patterns.rst new file mode 100644 index 00000000..f8afea69 --- /dev/null +++ b/docs/source/user_libs_antenna_patterns.rst @@ -0,0 +1,54 @@ +User libraries is a sub-package where useful Python modules contributed by users are stored. + +**************** +Antenna patterns +**************** + +Information +=========== + +**Author/Contact**: Craig Warren (Craig.Warren@ed.ac.uk), University of Edinburgh + +**License**: Creative Commons Attribution-ShareAlike 4.0 International License (http://creativecommons.org/licenses/by-sa/4.0/) + +**Attribution/cite**: Warren, C., Giannopoulos, A. (2016). Characterisation of a Ground Penetrating Radar Antenna in Lossless Homogeneous and Lossy Heterogeneous Environments. *Signal Processing* (http://dx.doi.org/10.1016/j.sigpro.2016.04.010) + +The package features contains modules to help calculate, process, and visualise field patterns from simulations that contain models of antennas. + +.. warning:: + + This package: + + * Does not calculate/plot conventional field patterns (at a single frequency). It uses a measure of the total energy of the electric field at a certain angle and radius, see http://dx.doi.org/10.1016/j.jappgeo.2013.08.001 + * Requires knowledge of Python to: contruct input files with antenna models and positioning of receivers; modify the saving and processing modules + * Can require significant computational resource depending on the observation distance from the antenna at which the field patterns are observed. The example models set with a maximum observation distance of 0.6m require ~30GB of RAM + +Module overview +=============== + +* ``initial_save.py`` is a module that calculates and stores (in a Numpy file) the field patterns from a model output file. +* ``plot_fields.py`` is a module that plots the field patterns. It should be used after the field pattern data has been processed and stored using the ``initial_save.py`` module. + +The package has been designed to work with input files that follow the following examples found in the ``user_models`` directory: + +* ``antenna_like_GSSI_1500_patterns_E.in`` is an input file that includes an antenna model to a GSSI 1.5 GHz antenna, and receivers to calculate a field pattern in the principal E-plane +* ``antenna_like_GSSI_1500_patterns_H.in`` is an input file that includes an antenna model to a GSSI 1.5 GHz antenna, and receivers to calculate a field pattern in the principal H-plane + + +How to use the module +===================== + +* Firstly you should familiarise yourself with the example model. Edit the input file as desired and run one of the simulations (either for a E-plane or H-plane pattern). +* Whilst the simulation is running edit the 'user configurable paramters' 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 antenna_like_GSSI_1500_patterns_E.out``. 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 antenna_like_GSSI_1500_patterns_E.npy`` + +.. tip:: + + If you want to create different plots you just need to edit and re-run the ``plot_fields.py`` module on the Numpy file, i.e. you don't have to re-process the output file. + + +.. figure:: images/user_libs/antenna_like_GSSI_1500_pattern_E_Er5.png + :width: 600 px + + Example of the E-plane pattern from a simulation containing an antenna model similar to a GSSI 1.5 GHz antenna over a homogeneous, lossless half-space with a relative permittivity of five. \ No newline at end of file