Updates to descriptions of usage.

docs/source/helper.rst

@@ -5,3 +5,16 @@ Helper utilities
 ****************
 
 This section provides information on how to use the Python modules (in the ``tools`` package) that help manage gprMax files.
+
+inputfile_old2new.py
+--------------------
+
+INSERT DESCRIPTION OF USAGE
+
+
+outputfiles_merge.py
+--------------------
+
+gprMax produces a separate output file for each trace (A-scan) in a B-scan. 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.
+
+UPDATE DESCRIPTION OF USAGE

docs/source/plotting.rst

@@ -9,23 +9,21 @@ A-scans
 =======
 
 plot_Ascan.py
-=============
+-------------
 
-.. automodule:: tools.plot_Ascan
+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 any 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``.
-    :members:
-    :undoc-members:
 
-* 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``.
+UPDATE DESCRIPTION OF USAGE
-
-* 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.
+plot_Bscan.py
+-------------
 
-* 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.
+gprMax produces a separate output file for each trace (A-scan) in the B-scan. 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 fieldcomponent``, where ``fieldcomponent`` is the name of field to plot, e.g. ``Ex``, ``Ey``, ``Ez``, ``Hx``, ``Hy`` or ``Hz``.
-* 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``.
+
+UPDATE DESCRIPTION OF USAGE
 
 
 .. _waveforms:
@@ -33,7 +31,15 @@ gprMax produces a separate output file for each trace (A-scan) in the B-scan.
 Built-in waveforms
 ==================
 
-This section provides definitions of the functions that are used to create the built-in waveforms. Example plots are shown using the parameters: amplitude of one, frequency of 1GHz, time window of 6ns, and a time step of 1.926ps.
+This section provides definitions of the functions that are used to create the built-in waveforms.
+
+plot_builtin_wave.py
+--------------------
+
+INSERT DESCRIPTION OF USAGE
+
+
+Example plots are shown using the parameters: amplitude of one, frequency of 1GHz, time window of 6ns, and a time step of 1.926ps.
 
 gaussian
 --------