From 3d912435234ff3fdd5c52e3eb9965fbdcdcd084d Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Tue, 29 Mar 2016 16:21:28 +0100 Subject: [PATCH] Further restructuring, --- docs/source/examples_advanced.rst | 6 +++--- docs/source/examples_simple_2D.rst | 6 +++--- docs/source/index.rst | 20 ++++++++++---------- docs/source/openmp_mpi.rst | 6 +++--- docs/source/user_libraries.rst | 10 +++++----- 5 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/source/examples_advanced.rst b/docs/source/examples_advanced.rst index af7b49d5..3fedf4d0 100644 --- a/docs/source/examples_advanced.rst +++ b/docs/source/examples_advanced.rst @@ -1,6 +1,6 @@ -****************** -Advanced modelling -****************** +***************** +Advanced features +***************** This section provides example models of some of the more advanced features of gprMax. Each example comes with an input file which you can download and run. diff --git a/docs/source/examples_simple_2D.rst b/docs/source/examples_simple_2D.rst index 0f7b3a2e..f0e1b009 100644 --- a/docs/source/examples_simple_2D.rst +++ b/docs/source/examples_simple_2D.rst @@ -1,6 +1,6 @@ -**************************** -Introductory/basic 2D models -**************************** +************************ +Introductory models (2D) +************************ This section provides some introductory example models in 2D that demonstrate basic features of gprMax. Each example comes with an input file which you can download and run. diff --git a/docs/source/index.rst b/docs/source/index.rst index 6fa163c1..412307e7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,22 +21,14 @@ gprMax User Guide .. toctree:: :maxdepth: 2 - :caption: Additional Python tools + :caption: Python tools plotting utils .. toctree:: :maxdepth: 2 - :caption: Advanced topics - - python_scripting - user_libraries - openmp_mpi - -.. toctree:: - :maxdepth: 2 - :caption: Examples + :caption: Example models examples_simple_2D examples_antennas @@ -49,6 +41,14 @@ gprMax User Guide faqs screencasts +.. toctree:: + :maxdepth: 2 + :caption: Advanced topics + + python_scripting + openmp_mpi + user_libraries + .. toctree:: :maxdepth: 2 :caption: Appendices diff --git a/docs/source/openmp_mpi.rst b/docs/source/openmp_mpi.rst index 81cbaf13..7935f928 100644 --- a/docs/source/openmp_mpi.rst +++ b/docs/source/openmp_mpi.rst @@ -1,8 +1,8 @@ .. _openmp-mpi: -************************ -Parallelism - OpenMP/MPI -************************ +*********** +Parallelism +*********** OpenMP ====== diff --git a/docs/source/user_libraries.rst b/docs/source/user_libraries.rst index 2765863b..af5a8f45 100644 --- a/docs/source/user_libraries.rst +++ b/docs/source/user_libraries.rst @@ -23,12 +23,12 @@ These antenna models can be accessed from within a block of Python code in your antenna_like_GSSI_1500(0.125, 0.094, 0.100, 0.001) #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). - -.. figure:: images/antenna_like_GSSI_1500.png - :width: 600 px - - FDTD geometry mesh showing an antenna model similar to a GSSI 1.5GHz antenna (skid removed for illustrative purposes).