Updates to user libraries docs.

这个提交包含在:
Craig Warren
2016-05-03 18:19:55 +01:00
父节点 9e3985b56c
当前提交 5634115afc
共有 3 个文件被更改,包括 81 次插入14 次删除

查看文件

@@ -4,6 +4,12 @@ User libraries is a sub-package where useful Python modules contributed by users
Antennas
********
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/)
.. code-block:: python
# Copyright (C) 2015-2016, Craig Warren
@@ -20,7 +26,21 @@ The module currently features models of antennas similar to commercial antennas:
A description of how the models were created can be found at http://dx.doi.org/10.1190/1.3548506.
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):
Module overview
===============
* `antennas.py` is a module containing the descriptions of the antennas.
How to use the module
=====================
The antenna models can be accessed from within a block of Python code in an input file. The models must be used with cubic spatial resolutions of either 1mm (default) or 2mm.
Example
-------
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