From e953882387284d96d80314c3afb9a92131caa912 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Mon, 12 Sep 2016 15:42:42 +0100 Subject: [PATCH] Updated/cleared up some of the text descriptions. --- docs/source/user_libs_antenna_patterns.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/user_libs_antenna_patterns.rst b/docs/source/user_libs_antenna_patterns.rst index 538fb0f0..ebcdb646 100644 --- a/docs/source/user_libs_antenna_patterns.rst +++ b/docs/source/user_libs_antenna_patterns.rst @@ -17,22 +17,22 @@ The package features contains modules to help calculate, process, and visualise .. warning:: - This package: + Although the principals of calculating and visualising field patterns are straightforward, this package should be used with care. The 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 + * Does not calculate/plot conventional field patterns, i.e. 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, as well as to edit/modify the saving and processing modules + * Can require simulations that demand significant computational resource depending on the distance from the antenna at which the field patterns are observed, e.g. 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. +* ``initial_save.py`` is a module that calculates and stores (in a Numpy file) the field patterns from the output file of a simulation. * ``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: +The package has been designed to work with input files that follow 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 +* ``antenna_like_GSSI_1500_patterns_E.in`` is an input file that includes an antenna model similar to a GSSI 1.5 GHz antenna and receivers to calculate a field pattern in the principal E-plane of the antenna +* ``antenna_like_GSSI_1500_patterns_H.in`` is an input file that includes an antenna model similar to a GSSI 1.5 GHz antenna and receivers to calculate a field pattern in the principal H-plane of the antenna How to use the module