From d4fdcf1adf335db0b141f61a04dc7bd8ede12301 Mon Sep 17 00:00:00 2001 From: craig-warren Date: Wed, 25 Nov 2015 18:05:31 +0000 Subject: [PATCH] Updated docs to reflect renaming of some tools scripts. --- README.rst | 2 +- docs/source/examples_2D.rst | 6 +++--- docs/source/output.rst | 8 ++++---- .../{outputfiles_mergehdf5.m => outputfiles_merge.m} | 2 +- tools/MATLAB scripts/{plot_Ascan_hdf5.m => plot_Ascan.m} | 2 +- tools/MATLAB scripts/{plot_Bscan_hdf5.m => plot_Bscan.m} | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) rename tools/MATLAB scripts/{outputfiles_mergehdf5.m => outputfiles_merge.m} (98%) rename tools/MATLAB scripts/{plot_Ascan_hdf5.m => plot_Ascan.m} (99%) rename tools/MATLAB scripts/{plot_Bscan_hdf5.m => plot_Bscan.m} (99%) diff --git a/README.rst b/README.rst index 656664b7..51e5f915 100644 --- a/README.rst +++ b/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 ------------------------------- diff --git a/docs/source/examples_2D.rst b/docs/source/examples_2D.rst index 6754040b..600d0663 100644 --- a/docs/source/examples_2D.rst +++ b/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. diff --git a/docs/source/output.rst b/docs/source/output.rst index 3b76f9ab..565fdfd4 100644 --- a/docs/source/output.rst +++ b/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``. diff --git a/tools/MATLAB scripts/outputfiles_mergehdf5.m b/tools/MATLAB scripts/outputfiles_merge.m similarity index 98% rename from tools/MATLAB scripts/outputfiles_mergehdf5.m rename to tools/MATLAB scripts/outputfiles_merge.m index 15d0826b..5523f65a 100644 --- a/tools/MATLAB scripts/outputfiles_mergehdf5.m +++ b/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 % diff --git a/tools/MATLAB scripts/plot_Ascan_hdf5.m b/tools/MATLAB scripts/plot_Ascan.m similarity index 99% rename from tools/MATLAB scripts/plot_Ascan_hdf5.m rename to tools/MATLAB scripts/plot_Ascan.m index c72460cb..0e48cbef 100644 --- a/tools/MATLAB scripts/plot_Ascan_hdf5.m +++ b/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 diff --git a/tools/MATLAB scripts/plot_Bscan_hdf5.m b/tools/MATLAB scripts/plot_Bscan.m similarity index 99% rename from tools/MATLAB scripts/plot_Bscan_hdf5.m rename to tools/MATLAB scripts/plot_Bscan.m index b7f0b926..f100a7a1 100644 --- a/tools/MATLAB scripts/plot_Bscan_hdf5.m +++ b/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