Initial devel doc tidying

docs/source/coding.rst

@@ -1,19 +0,0 @@
-.. _coding:
-
-*************
-Code Overview
-*************
-
-This section aims to provide information and advice for developers who want to
-get started using and modifying the gprMax code.
-
-The code has been written in Python (3.x) with performance-critical parts, i.e.
-the FDTD solver, written using Cython (for CPU) or the NVIDIA CUDA programming
-model (for GPU). Cython allows the CPU-based solver to be parallelised using
-OpenMP which enables it to run on multi-core CPUs. gprMax also features a
-Messaging Passing Interface (MPI) task farm, which can operate with CPU nodes or
-multiple GPUs.
-
-.. figure:: ../../images_shared/code_overview.png
-
-    Basic, high-level overview of the flow of control (operation) of the code.

docs/source/faqs.rst

@@ -2,7 +2,7 @@
 FAQs
 ****
 
-This section provides answers to frequently asked questions about gprMax and its uses.
+This section provides answers to frequently asked questions about gprMax and its uses. You should also check out our `YouTube channel <https://www.youtube.com/@Gprmax>`_ which contains screencasts and videos that explain how to install gprMax, demonstrate some of its key features, and give example models showing applications.
 
 **What applications can gprMax simulate?**
 gprMax is electromagnetic wave simulation software that is based on the Finite-Difference Time-Domain (FDTD) method. Many of its features have been designed to benefit simulating Ground Penetrating Radar (GPR), however it can be used to simulate many other applications in areas such as engineering, geophysics, archaeology, and medicine.
@@ -17,7 +17,7 @@ gprMax is released under the `GNU General Public License v3 or higher <http://ww
 The name gprMax comes from the joining of the acroymn for Ground Penetrating Radar - **gpr** - and the name of the Scottish scientist who formulated the classical theory of electromagnetic radiation, `James Clerk Maxwell <https://en.wikipedia.org/wiki/James_Clerk_Maxwell>`_ - **Max**.
 
 **Do I need to learn Python to use gprMax?**
-No, but it can be beneficial to know a little Python. We have made it easier to create more complex simulations in gprMax through scripting in the input file. This is achieved by allowing blocks of Python code to be written in the input file which are executed when the file is read by gprMax.
+No, you can use gprMax purely through commands in your input. However, gprMax also has a Python API which can be used to create more complex simulations and scripting.
 
 **Can I still do all my pre/post-processing for gprMax in MATLAB?**
 Yes, `MATLAB has built-in functions to read HDF5 files <http://uk.mathworks.com/help/matlab/high-level-functions.html>`_.
@@ -25,9 +25,6 @@ Yes, `MATLAB has built-in functions to read HDF5 files <http://uk.mathworks.com/
 **Can I convert my output file to a text file, e.g. to import into Microsoft Excel**
 Yes, we recommend you download `HDFView <https://support.hdfgroup.org/products/java/hdfview/>`_ which is free viewer for HDF files. You can then export any of datasets in the output file to a text (ASCII) file that can be imported into Microsoft Excel. To do so right-click on the dataset in HDFView and choose Export Dataset -> Export Data to Text File.
 
-**But converting my input file from the old version of gprMax will be really painful**
-Hopefully not! We have provided a Python module to help you convert input files from the old version of gprMax to use syntax introduced in version 3.
-
 **How do I choose a spatial resolution for my simulation?**
 Spatial resolution should be chosen to mitigate numerical dispersion and to adequately resolve geometry in your simulation. :ref:`A 2D example of modelling a metal cylinder in a dielectric <example-2D-Ascan>` provides guidance on how to determine spatial resolution.
 

docs/source/index.rst

@@ -9,6 +9,7 @@ gprMax User Guide
     inc_README
     features
     gprmodelling
+    faqs
 
 
 .. toctree::
@@ -36,7 +37,7 @@ gprMax User Guide
 
 .. toctree::
     :maxdepth: 2
-    :caption: User libraries
+    :caption: Toolboxes
 
     inc_GPRAntennaModels
     inc_AntennaPatterns
@@ -54,14 +55,6 @@ gprMax User Guide
     examples_antennas
     examples_advanced
 
-.. toctree::
-    :maxdepth: 2
-    :caption: Help and support
-
-    faqs
-    screencasts
-    coding
-
 .. toctree::
     :maxdepth: 2
     :caption: Accuracy and performance

docs/source/screencasts.rst

@@ -1,32 +0,0 @@
-.. _screencasts:
-
-********************
-Screencasts & videos
-********************
-
-This section provides links to screencasts and videos that explain how to install gprMax, demonstrate some of its key features, and give example models showing applications.
-
-Installation
-------------
-
-These screencasts are demonstrated on Microsoft Windows 7, but the installation and updating procedure is the same for other versions of Windows, and quite similar for Linux and macOS also. Detailed written installation and updating instructions are provided in the Getting Started section.
-
-* `How to install gprMax on Microsoft Windows <https://youtu.be/YkPWMmJILcI>`_
-* `How to update gprMax on Microsoft Windows <https://youtu.be/e0ROY792s9o>`_
-
-
-Plotting
---------
-
-How to plot time and frequency domain representations of source waveforms and field outputs.
-
-* `Plotting source waveforms using a Jupyter notebook <https://youtu.be/zaf0w8Np2cU>`_
-
-
-Visualise EM wave propagation
------------------------------
-
-You can use the ``#snapshot`` command and Paraview to visualise how electromagnetic waves propagate in a simulation.
-
-* `PEC cylinder buried in a lossless half-space (2D) <https://youtu.be/BpBo0-SFda4>`_
-* `PEC cylinder buried in different half-spaces (2D) <https://youtu.be/g744O_wb14I>`_