From d255705f907167caf4fb68c794d43d01c3e81b09 Mon Sep 17 00:00:00 2001 From: craig-warren Date: Wed, 11 May 2016 21:34:47 +0100 Subject: [PATCH] Updated description of package. --- docs/source/user_libs_austinman.rst | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/source/user_libs_austinman.rst b/docs/source/user_libs_austinman.rst index 5ec15d8c..a1495b27 100644 --- a/docs/source/user_libs_austinman.rst +++ b/docs/source/user_libs_austinman.rst @@ -27,8 +27,6 @@ AustinMan and AustinWoman (http://bit.ly/AustinMan) are open source electromagne FDTD geometry mesh showing the head of the AustinMan model (2x2x2mm :math:`^3`). -The AustinMan and AustinWoman models are not currently included in the user libraries sub-package, however they can be downloaded from http://bit.ly/AustinMan. - The following whole body models are available. =========== ========================== ================== @@ -44,16 +42,23 @@ AustinWoman 2x2x2 342 x 187 x 865 AustinWoman 1x1x1 683 x 374 x 1730 =========== ========================== ================== +Package overview +================ + +.. code-block:: none + + AustinManWoman_gprMax_materials.txt + AustinManWoman_gprMax_materials_dispersive.txt + +* ``AustinManWoman_gprMax_materials.txt`` is a text file containing non-dispersive material properties at 900 MHz (http://niremf.ifac.cnr.it/tissprop/). +* ``AustinManWoman_gprMax_materials_dispersive.txt`` is a text file containing dispersive material properties using a 3-pole Debye model (http://dx.doi.org/10.1109/LMWC.2011.2180371). Note the main body tissues are described using a 3-pole Debye model, nbut ot all materials have a dispersive description. + How to use the models ===================== -From http://bit.ly/AustinMan: +The AustinMan and AustinWoman models themselves are not included in the user libraries sub-package. -* Download a HDF5 file (.h5) of AustinMan or AustinWoman at the resolution you wish to use. -* Download a text file of material descriptions for gprMax, either - - * ``AustinManWoman_gprMax_materials.txt`` for non-dispersive material properties at 900 MHz (http://niremf.ifac.cnr.it/tissprop/). - * ``AustinManWoman_gprMax_materials_dispersive.txt`` for dispersive material properties that feature a 3-pole Debye model (http://dx.doi.org/10.1109/LMWC.2011.2180371). Not all materials have a dispersive description. +* Download a HDF5 file (.h5) of AustinMan or AustinWoman at the resolution you wish to use from http://bit.ly/AustinMan To insert either AustinMan or AustinWoman models into a simulation use the ``#geometry_objects_file``. @@ -66,7 +71,7 @@ To insert a 2x2x2mm :math:`^3` AustinMan with the lower left corner 40mm from th #geometry_objects_file: 0.04 0.04 0.04 ../user_libs/AustinManWoman/AustinMan_v2.3_2x2x2.h5 ../user_libs/AustinManWoman/AustinManWoman_gprMax_materials_dispersive.txt -For further information on the `#geometry_objects_file` see the section on object contruction commands in the :ref:`Input commands section `. +For further information on the ``#geometry_objects_file`` see the section on object contruction commands in the :ref:`Input commands section `. .. figure:: images/user_libs/AustinMan.png :width: 300 px