From 6151bdae8607ba9c4249e03b87b231f73b23ce3f Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Thu, 28 Jan 2016 09:35:12 +0000 Subject: [PATCH] Restructure to add analytical comparisons. --- ...{examples_analytical.rst => analytical_comparisons.rst} | 6 +++--- docs/source/index.rst | 7 ++++++- docs/source/readme_install_devs.rst | 2 +- 3 files changed, 10 insertions(+), 5 deletions(-) rename docs/source/{examples_analytical.rst => analytical_comparisons.rst} (74%) diff --git a/docs/source/examples_analytical.rst b/docs/source/analytical_comparisons.rst similarity index 74% rename from docs/source/examples_analytical.rst rename to docs/source/analytical_comparisons.rst index 067e6a56..c70800cc 100644 --- a/docs/source/examples_analytical.rst +++ b/docs/source/analytical_comparisons.rst @@ -15,14 +15,14 @@ This example is of a Hertzian dipole, i.e. an additive source (electric current :language: none :linenos: -The following module calculates the analytical solution. +The function ``hertzian_dipole_fs`` in the ``analytical solutions`` module in the ``tests`` sub-package was written to compute the analytical solution. -.. automodule:: tests.analytical_solutions +.. autofunction:: tests.analytical_solutions.hertzian_dipole_fs Results ------- -:numref:`hertzian_dipole_fs_results` shows the time history of the electric and magnetic field components of the modelled and analytical solutions. Since they are so similar, :numref:`hertzian_dipole_fs_results_diffs` shows the percentage differences. +:numref:`hertzian_dipole_fs_results` shows the time history of the electric and magnetic field components of the modelled and analytical solutions. The responses overlap one another due to their similarity. Therefore, :numref:`hertzian_dipole_fs_results_diffs` shows the percentage differences between the solutions. .. _hertzian_dipole_fs_results: diff --git a/docs/source/index.rst b/docs/source/index.rst index d8f70a91..b33f2305 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -37,7 +37,6 @@ gprMax User Guide :maxdepth: 2 :caption: Examples - examples_analytical examples_simple_2D examples_antennas examples_advanced @@ -48,5 +47,11 @@ gprMax User Guide faqs screencasts + +.. toctree:: + :maxdepth: 2 + :caption: Appendices + + analytical_comparisons references diff --git a/docs/source/readme_install_devs.rst b/docs/source/readme_install_devs.rst index b78c36be..a151f7bf 100644 --- a/docs/source/readme_install_devs.rst +++ b/docs/source/readme_install_devs.rst @@ -73,6 +73,6 @@ b) Compile the Cython extension modules using: :code:`python setup.py build_ext .. note:: -If you want to remove/clean Cython generated files, e.g. before rebuilding the Cython extensions, you can use :code:`python setup.py cleanall`. + If you want to remove/clean Cython generated files, e.g. before rebuilding the Cython extensions, you can use :code:`python setup.py cleanall`. **You are now ready to proceed to running gprMax.** \ No newline at end of file