From 376438ef62c7ed96d9b7c69733db6235b3c4aec5 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Wed, 6 Apr 2016 10:39:51 +0100 Subject: [PATCH] Updated details on antennas.py module. --- docs/source/user_libraries.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/source/user_libraries.rst b/docs/source/user_libraries.rst index 4d13014c..40da0b66 100644 --- a/docs/source/user_libraries.rst +++ b/docs/source/user_libraries.rst @@ -9,27 +9,29 @@ User libraries is a sub-package where useful Python modules contributed by users antennas.py =========== - Copyright (C) 2015-2016, Craig Warren +.. code-block:: python - This module is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. - To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/. + # Copyright (C) 2015-2016, Craig Warren + # + # This module is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. + # To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/. + # + # Please use the attribution at http://dx.doi.org/10.1190/1.3548506 - Please use the attribution at http://dx.doi.org/10.1190/1.3548506 - -This module currently features models of antennas similar to: +The module currently features models of antennas similar to: * a Geophysical Survey Systems, Inc. (GSSI) 1.5 GHz (Model 5100) antenna (http://www.geophysical.com) * a MALA Geoscience 1.2 GHz antenna (http://www.malags.com/) -Details of how the models were created can be found at http://dx.doi.org/10.1190/1.3548506 +A description of how the models were created can be found at http://dx.doi.org/10.1190/1.3548506. -These antenna models can be accessed from within a block of Python code in your simulation. For example, to use Python to include an antenna model similar to a GSSI 1.5 GHz antenna at a location 0.125m, 0.094m, 0.100m (x,y,z) using a 1mm spatial resolution: +The antenna models can be accessed from within a block of Python code in your simulation. The models must be used with cubic spatial resolutions of either 1mm (default) or 2mm. For example, to use Python to include an antenna model similar to a GSSI 1.5 GHz antenna at a location 0.125m, 0.094m, 0.100m (x,y,z): .. code-block:: none #python: from user_libs.antennas import antenna_like_GSSI_1500 - antenna_like_GSSI_1500(0.125, 0.094, 0.100, 0.001) + antenna_like_GSSI_1500(0.125, 0.094, 0.100) #end_python: .. figure:: images/antenna_like_GSSI_1500.png