diff --git a/docs/source/index.rst b/docs/source/index.rst index 8dee6fde..4ab27988 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -37,7 +37,8 @@ gprMax User Guide :maxdepth: 2 :caption: User libraries - user_libraries + user_libs_antennas + user_libs_austinman .. toctree:: :maxdepth: 2 diff --git a/docs/source/user_libs_antennas.rst b/docs/source/user_libs_antennas.rst new file mode 100644 index 00000000..5088444b --- /dev/null +++ b/docs/source/user_libs_antennas.rst @@ -0,0 +1,41 @@ + +User libraries is a sub-package where useful Python modules contributed by users are stored. + +*********** +antennas.py +*********** + +.. code-block:: python + + # 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 + +The module currently features models of antennas similar to commercial antennas: + +* Geophysical Survey Systems, Inc. (GSSI) 1.5 GHz (Model 5100) antenna (http://www.geophysical.com) +* MALA Geoscience 1.2 GHz antenna (http://www.malags.com/) + +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): + +.. code-block:: none + + #python: + from user_libs.antennas import antenna_like_GSSI_1500 + antenna_like_GSSI_1500(0.125, 0.094, 0.100) + #end_python: + +.. figure:: images/antenna_like_GSSI_1500.png + :width: 600 px + + FDTD geometry mesh showing an antenna model similar to a GSSI 1.5 GHz antenna (skid removed for illustrative purposes). + +.. figure:: images/antenna_like_MALA_1200.png + :width: 600 px + + FDTD geometry mesh showing an antenna model similar to a MALA 1.2GHz antenna (skid removed for illustrative purposes). \ No newline at end of file diff --git a/docs/source/user_libraries.rst b/docs/source/user_libs_austinman.rst similarity index 64% rename from docs/source/user_libraries.rst rename to docs/source/user_libs_austinman.rst index c1634484..f523deb4 100644 --- a/docs/source/user_libraries.rst +++ b/docs/source/user_libs_austinman.rst @@ -1,52 +1,8 @@ -.. _user-libs: - -************** -User libraries -************** - User libraries is a sub-package where useful Python modules contributed by users are stored. -antennas.py -=========== - -.. code-block:: python - - # 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 - -The module currently features models of antennas similar to commercial antennas: - -* Geophysical Survey Systems, Inc. (GSSI) 1.5 GHz (Model 5100) antenna (http://www.geophysical.com) -* MALA Geoscience 1.2 GHz antenna (http://www.malags.com/) - -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): - -.. code-block:: none - - #python: - from user_libs.antennas import antenna_like_GSSI_1500 - antenna_like_GSSI_1500(0.125, 0.094, 0.100) - #end_python: - -.. figure:: images/antenna_like_GSSI_1500.png - :width: 600 px - - FDTD geometry mesh showing an antenna model similar to a GSSI 1.5 GHz antenna (skid removed for illustrative purposes). - -.. figure:: images/antenna_like_MALA_1200.png - :width: 600 px - - FDTD geometry mesh showing an antenna model similar to a MALA 1.2GHz antenna (skid removed for illustrative purposes). - - +*********************** AustinMan & AustinWoman -======================= +*********************** .. code-block:: python