Moved images to shared directory at top-level

docs/source/coding.rst

@@ -14,6 +14,6 @@ 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/code_overview.png
+.. figure:: ../../images_shared/code_overview.png
 
     Basic, high-level overview of the flow of control (operation) of the code.

docs/source/conf.py

@@ -144,7 +144,7 @@ html_title = 'gprMax User Guide'
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-# html_logo = 'images/gprMax_FB_logo.png'
+html_logo = '../../images_shared/gprMax_FB_logo.png'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -246,7 +246,7 @@ latex_documents = [
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-latex_logo = 'images/gprMax_logo.png'
+latex_logo = '../../images_shared/gprMax_logo.png'
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.

docs/source/examples_advanced.rst

@@ -15,7 +15,7 @@ This example demonstrates how to build a more realistic soil model using a stoch
     :language: none
     :linenos:
 
-.. figure:: images/heterogeneous_soil.png
+.. figure:: ../../images_shared/heterogeneous_soil.png
     :width: 600 px
 
     FDTD geometry mesh showing a heterogeneous soil model with a rough surface.

docs/source/examples_antennas.rst

@@ -32,21 +32,21 @@ You can view the results (see :ref:`output` and :ref:`tools<plotting>` sections)
 
 .. _antenna_wire_dipole_fs_tl_params:
 
-.. figure:: images/antenna_wire_dipole_fs_tl_params.png
+.. figure:: ../../images_shared/antenna_wire_dipole_fs_tl_params.png
     :width: 600px
 
     Time and frequency domain plots of the incident and total (incident + reflected) voltages and currents in the transmission line (:math:`\Delta f = 17~MHz`).
 
 .. _antenna_wire_dipole_fs_ant_params:
 
-.. figure:: images/antenna_wire_dipole_fs_ant_params.png
+.. figure:: ../../images_shared/antenna_wire_dipole_fs_ant_params.png
     :width: 600px
 
     Input admittance and impedance (resistance and reactance) and s11 parameter values of the antenna (:math:`\Delta f = 17~MHz`).
 
 .. _antenna_wire_dipole_fs_ant_params_detail:
 
-.. figure:: images/antenna_wire_dipole_fs_ant_params_detail.png
+.. figure:: ../../images_shared/antenna_wire_dipole_fs_ant_params_detail.png
     :width: 600px
 
     Detailed view of input admittance and impedance (resistance and reactance) and s11 parameter values of the antenna (:math:`\Delta f = 17~MHz`).
@@ -57,7 +57,7 @@ You can view the results (see :ref:`output` and :ref:`tools<plotting>` sections)
 
 .. _antenna_wire_dipole_fs_ant_params_detail_1p4MHz:
 
-.. figure:: images/antenna_wire_dipole_fs_ant_params_detail_1p4MHz.png
+.. figure:: ../../images_shared/antenna_wire_dipole_fs_ant_params_detail_1p4MHz.png
     :width: 600px
 
     Detailed view of input admittance and impedance (resistance and reactance) and s11 parameter values of the antenna (:math:`\Delta f = 1.4~MHz`)
@@ -76,7 +76,7 @@ This example demonstrates how to use one of the built-in antenna models in a sim
     :language: none
     :linenos:
 
-.. figure:: images/antenna_like_MALA_1200.png
+.. figure:: ../../images_shared/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).
@@ -96,7 +96,7 @@ When the simulation is run two geometry files for the antenna are produced along
 
 .. _antenna_like_MALA_1200_fs_results:
 
-.. figure:: images/antenna_like_MALA_1200_fs_results.png
+.. figure:: ../../images_shared/antenna_like_MALA_1200_fs_results.png
     :width: 600 px
 
     Ey field output from the receiver bowtie of a model of an antenna similar to a MALA 1.2GHz antenna.
@@ -113,7 +113,7 @@ This example demonstrates how to create a B-scan with an antenna model. The scen
     :language: none
     :linenos:
 
-.. figure:: images/cylinder_Bscan_GSSI_1500.png
+.. figure:: ../../images_shared/cylinder_Bscan_GSSI_1500.png
     :width: 600 px
 
     FDTD geometry mesh showing a metal cylinder buried in a half-space and an antenna model similar to a GSSI 1.5GHz antenna.
@@ -143,7 +143,7 @@ After merging the A-scans into a single file you can now view an image of the B-
 
 .. _cylinder_Bscan_GSSI_1500_results:
 
-.. figure:: images/cylinder_Bscan_GSSI_1500_results.png
+.. figure:: ../../images_shared/cylinder_Bscan_GSSI_1500_results.png
     :width: 600px
 
     B-scan of model of a metal cylinder buried in a dielectric half-space with a model of an antenna similar to a GSSI 1.5GHz antenna.

docs/source/examples_simple_2D.rst

@@ -21,7 +21,7 @@ The geometry of the scenario is straightforward and an image created from the ge
 
 .. _cylinder_half_space_geo:
 
-.. figure:: images/cylinder_half_space_geo.png
+.. figure:: ../../images_shared/cylinder_half_space_geo.png
     :width: 600 px
 
     Geometry of a 2D model of a metal cylinder buried in a dielectric half-space.
@@ -118,7 +118,7 @@ You should have produced an output file ``cylinder_Ascan_2D.h5``. You can view t
 
 .. _cylinder_Ascan_results:
 
-.. figure:: images/cylinder_Ascan_results.png
+.. figure:: ../../images_shared/cylinder_Ascan_results.png
     :width: 600px
 
     Electric and magnetic field component time histories from the receiver in the model of a metal cylinder buried in a dielectric half-space.
@@ -167,7 +167,7 @@ You can now view an image of the B-scan using the command:
 
 .. _cylinder_Bscan_results:
 
-.. figure:: images/cylinder_Bscan_results.png
+.. figure:: ../../images_shared/cylinder_Bscan_results.png
     :width: 600px
 
     B-scan of model of a metal cylinder buried in a dielectric half-space.

docs/source/gprmodelling.rst

@@ -29,7 +29,7 @@ temporal :math:`\Delta t` steps play a very significant role -- since the smalle
 
 .. _yeecell3D:
 
-.. figure:: images/yeecell3d.png
+.. figure:: ../../images_shared/yeecell3d.png
     :width: 500px
 
     Single FDTD Yee cell showing electric (red) and magnetic (green) field components.
@@ -40,7 +40,7 @@ gprMax is fundamentally based on solving Maxwell's equations in 3D using the FDT
 
 .. _yeecell2DTMz:
 
-.. figure:: images/yeecell2dTMz.png
+.. figure:: ../../images_shared/yeecell2dTMz.png
     :width: 500px
 
     Single FDTD Yee cell showing electric (red), magnetic (green), and zeroed out (grey) field components for 2D transverse magnetic (TM) z-direction mode.
@@ -80,7 +80,7 @@ A right-handed Cartesian coordinate system is used with the origin of space coor
 
 .. _coord3d:
 
-.. figure:: images/coord3d.png
+.. figure:: ../../images_shared/coord3d.png
     :width: 500px
 
     gprMax coordinate system and conventions.
@@ -122,7 +122,7 @@ One of the most challenging issues in modelling *open boundary* problems, such a
 
 .. _abcs:
 
-.. figure:: images/abcs.png
+.. figure:: ../../images_shared/abcs.png
     :width: 600px
 
     GPR forward problem showing computational domain bounded by Absorbing Boundary Conditions (ABCs)

docs/source/include_readme.rst

@@ -1 +0,0 @@
-.. include:: ../../README.rst

docs/source/output.rst

@@ -141,7 +141,7 @@ The ``#geometry_view:`` command produces either ImageData (.vti) for a per-cell
 
 .. _pv_toolbar:
 
-.. figure:: images/paraview_toolbar.png
+.. figure:: ../../images_shared/paraview_toolbar.png
 
     Paraview toolbar showing ``gprMax_info`` macro button.
 
@@ -152,7 +152,7 @@ The ``#geometry_view:`` command produces either ImageData (.vti) for a per-cell
 
 .. _pv_pipeline:
 
-.. figure:: images/paraview_pipeline.png
+.. figure:: ../../images_shared/paraview_pipeline.png
     :width: 350 px
 
     Paraview Pipeline Browser showing list of materials in an example model.

docs/source/plotting.rst

@@ -118,7 +118,7 @@ A Gaussian waveform.
 
 where :math:`\zeta = 2\pi^2f^2`, :math:`\chi=\frac{1}{f}` and :math:`f` is the frequency.
 
-.. figure:: images/gaussian.png
+.. figure:: ../../images_shared/gaussian.png
 
     Example of the ``gaussian`` waveform - time domain and power spectrum.
 
@@ -132,7 +132,7 @@ First derivative of a Gaussian waveform.
 
 where :math:`\zeta = 2\pi^2f^2`, :math:`\chi=\frac{1}{f}` and :math:`f` is the frequency.
 
-.. figure:: images/gaussiandot.png
+.. figure:: ../../images_shared/gaussiandot.png
 
     Example of the ``gaussiandot`` waveform - time domain and power spectrum.
 
@@ -146,7 +146,7 @@ Normalised first derivative of a Gaussian waveform.
 
 where :math:`\zeta = 2\pi^2f^2`, :math:`\chi=\frac{1}{f}` and :math:`f` is the frequency.
 
-.. figure:: images/gaussiandotnorm.png
+.. figure:: ../../images_shared/gaussiandotnorm.png
 
     Example of the ``gaussiandotnorm`` waveform - time domain and power spectrum.
 
@@ -160,7 +160,7 @@ Second derivative of a Gaussian waveform.
 
 where :math:`\zeta = \pi^2f^2`, :math:`\chi=\frac{\sqrt{2}}{f}` and :math:`f` is the frequency.
 
-.. figure:: images/gaussiandotdot.png
+.. figure:: ../../images_shared/gaussiandotdot.png
 
     Example of the ``gaussiandotdot`` waveform - time domain and power spectrum.
 
@@ -174,7 +174,7 @@ Normalised second derivative of a Gaussian waveform.
 
 where :math:`\zeta = \pi^2f^2`, :math:`\chi=\frac{\sqrt{2}}{f}` and :math:`f` is the frequency.
 
-.. figure:: images/gaussiandotdotnorm.png
+.. figure:: ../../images_shared/gaussiandotdotnorm.png
 
     Example of the ``gaussiandotdotnorm`` waveform - time domain and power spectrum.
 
@@ -188,7 +188,7 @@ A Ricker (or Mexican Hat) waveform which is the negative, normalised second deri
 
 where :math:`\zeta = \pi^2f^2`, :math:`\chi=\frac{\sqrt{2}}{f}` and :math:`f` is the frequency.
 
-.. figure:: images/ricker.png
+.. figure:: ../../images_shared/ricker.png
 
     Example of the ``ricker`` waveform - time domain and power spectrum.
 
@@ -212,7 +212,7 @@ and
 
 :math:`f` is the frequency
 
-.. figure:: images/sine.png
+.. figure:: ../../images_shared/sine.png
 
     Example of the ``sine`` waveform - time domain and power spectrum.
 
@@ -236,6 +236,6 @@ and
 
 where :math:`R_c` is set to :math:`0.25` and :math:`f` is the frequency.
 
-.. figure:: images/contsine.png
+.. figure:: ../../images_shared/contsine.png
 
     Example of the ``contsine`` waveform - time domain and power spectrum.