Updated docs to reflect renaming of some tools scripts.

README.rst

@@ -182,7 +182,7 @@ When the simulation is complete you can plot the A-scan using:
 
 .. code-block:: none
 
-    python -m tools.plot_Ascan_hdf5 user_models/cylinder_Ascan_2D.out
+    python -m tools.plot_Ascan user_models/cylinder_Ascan_2D.out
 
 Optional command line arguments
 -------------------------------

docs/source/examples_2D.rst

@@ -117,7 +117,7 @@ You should have produced an output file ``cylinder_Ascan_2D.out``. You can view
 
 .. code-block:: none
 
-    python -m tools.plot_Ascan_hdf5 cylinder_Ascan_2D.out
+    python -m tools.plot_Ascan cylinder_Ascan_2D.out
 
 :numref:`cylinder_Ascan_results` shows the time history of the electric and magnetic field components at the receiver location. The :math:`E_z` field component can be converted to voltage which represents the A-scan (trace). The initial part of the signal (<1.5 ns) represents the direct wave from transmitter to receiver. Then comes the reflected wavelet from the metal cylinder.
 
@@ -155,7 +155,7 @@ You should have produced 60 output files, one for each A-scan, with names ``cyli
 
 .. code-block:: none
 
-    python -m tools.outputfiles_mergehdf5 cylinder_Bscan_2D 60
+    python -m tools.outputfiles_merge cylinder_Bscan_2D 60
 
 You should see a combined output file ``cylinder_Bscan_2D_all.out``. The tool will ask you if you want to delete the original single A-scan output files or keep them.
 
@@ -163,7 +163,7 @@ You can now view an image of the B-scan using the command:
 
 .. code-block:: none
 
-    python -m tools.plot_Bscan_hdf5 cylinder_Bscan_2D_all.out Ez
+    python -m tools.plot_Bscan cylinder_Bscan_2D_all.out Ez
 
 :numref:`cylinder_Bscan_results` shows the B-scan (image of the Ez field). As expected a hyperbolic response is present from the metal cylinder.
 

docs/source/output.rst

@@ -66,16 +66,16 @@ There are a number of free tools available to read HDF5 files. Also MATLAB has h
 A-scans
 -------
 
-* Plot A-scans using the Python module ``plot_Ascan_hdf5.py``. The module uses matplotlib to plot the time history for the electric and magnetic field components for all receivers in a model (each receiver gets a separate figure window). Usage (from the top-level gprMax directory) is: ``python -m tools.plot_Ascan_hdf5 my_outputfile.out``.
+* Plot A-scans using the Python module ``plot_Ascan.py``. The module uses matplotlib to plot the time history for the electric and magnetic field components for all receivers in a model (each receiver gets a separate figure window). Usage (from the top-level gprMax directory) is: ``python -m tools.plot_Ascan my_outputfile.out``.
 
-* Plot A-scans using the MATLAB script ``plot_Ascan_hdf5.m``. The script plots the time history for the electric and magnetic field components for all receivers in a model (each receiver gets a separate figure window).
+* Plot A-scans using the MATLAB script ``plot_Ascan.m``. The script plots the time history for the electric and magnetic field components for all receivers in a model (each receiver gets a separate figure window).
 
 B-scans
 -------
 
 gprMax produces a separate output file for each trace (A-scan) in the B-scan.
 
-* Combine the separate output files into one file using the Python module ``outputfiles_mergehdf5.py``. Usage (from the top-level gprMax directory) is: ``python -m tools.outputfiles_mergehdf5 basefilename modelruns``, where ``basefilename`` is the base name file of the output file series, e.g. for ``myoutput1.out``, ``myoutput2.out`` the base file name would be ``myoutput``, and ``modelruns`` is the number of output files to combine.
-* Plot an image of the B-scan using the Python module ``plot_Bscan_hdf5.py``. Usage (from the top-level gprMax directory) is: ``python -m tools.plot_Bscan_hdf5 my_outputfile.out field``, where ``field`` is the name of field to plot, e.g. ``Ex``, ``Ey`` or ``Ez``.
+* Combine the separate output files into one file using the Python module ``outputfiles_merge.py``. Usage (from the top-level gprMax directory) is: ``python -m tools.outputfiles_merge basefilename modelruns``, where ``basefilename`` is the base name file of the output file series, e.g. for ``myoutput1.out``, ``myoutput2.out`` the base file name would be ``myoutput``, and ``modelruns`` is the number of output files to combine.
+* Plot an image of the B-scan using the Python module ``plot_Bscan.py``. Usage (from the top-level gprMax directory) is: ``python -m tools.plot_Bscan my_outputfile.out field``, where ``field`` is the name of field to plot, e.g. ``Ex``, ``Ey`` or ``Ez``.
 
 

tools/MATLAB scripts/outputfiles_merge.m

@@ -1,4 +1,4 @@
-% outputfiles_mergehdf5.m
+% outputfiles_merge.m
 % Script to merge gprMax output files of A-scans (traces) into a single
 % HDF5 file
 %

tools/MATLAB scripts/plot_Ascan.m

@@ -1,4 +1,4 @@
-% plot_Ascan_hdf5.m
+% plot_Ascan.m
 % Script to save and plot EM fields from a gprMax A-scan
 %
 % Craig Warren

tools/MATLAB scripts/plot_Bscan.m

@@ -1,4 +1,4 @@
-% plot_Bscan_hdf5.m
+% plot_Bscan.m
 % Script to plot EM fields from a gprMax B-scan
 %
 % Craig Warren