diff --git a/docs/source/examples_simple_2D.rst b/docs/source/examples_simple_2D.rst index d0d96f63..66ea9555 100644 --- a/docs/source/examples_simple_2D.rst +++ b/docs/source/examples_simple_2D.rst @@ -108,11 +108,11 @@ You can now run the model: View the results ---------------- -You should have produced an output file ``cylinder_Ascan_2D.out``. You can view the results (see :ref:`output` section) using the command: +You should have produced an output file ``cylinder_Ascan_2D.h5``. You can view the results (see :ref:`output` section) using the command: .. code-block:: none - python -m tools.plot_Ascan user_models/cylinder_Ascan_2D.out + python -m tools.plot_Ascan user_models/cylinder_Ascan_2D.h5 :numref:`cylinder_Ascan_results` shows the time history of the electric and magnetic field components and currents 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 (~0.5-1.5 ns) represents the direct wave from transmitter to receiver. Then comes the reflected wavelet (~1.8-2.6 ns), which has opposite polarity, from the metal cylinder. @@ -149,19 +149,19 @@ To run the model to create a B-scan you must pass an optional argument to specif Results ------- -You should have produced 60 output files, one for each A-scan, with names ``cylinder_Bscan_2D1.out``, ``cylinder_Bscan_2D2.out`` etc... These can be combined into a single file using the command: +You should have produced 60 output files, one for each A-scan, with names ``cylinder_Bscan_2D1.h5``, ``cylinder_Bscan_2D2.h5`` etc... These can be combined into a single file using the command: .. code-block:: none python -m tools.outputfiles_merge user_models/cylinder_Bscan_2D -You should see a combined output file ``cylinder_Bscan_2D_merged.out``. You can add the optional argument ``--remove-files`` if you want to automatically delete the original single A-scan output files. +You should see a combined output file ``cylinder_Bscan_2D_merged.h5``. You can add the optional argument ``--remove-files`` if you want to automatically delete the original single A-scan output files. You can now view an image of the B-scan using the command: .. code-block:: none - python -m tools.plot_Bscan user_models/cylinder_Bscan_2D_merged.out Ez + python -m tools.plot_Bscan user_models/cylinder_Bscan_2D_merged.h5 Ez :numref:`cylinder_Bscan_results` shows the B-scan (of the :math:`E_z` field component). Again, the initial part of the signal (~0.5-1.5 ns) represents the direct wave from transmitter to receiver. Then comes the refelected wave (~2-3 ns) from the metal cylinder which creates the hyperbolic shape. diff --git a/docs/source/output.rst b/docs/source/output.rst index ccd14031..9052c928 100644 --- a/docs/source/output.rst +++ b/docs/source/output.rst @@ -7,7 +7,7 @@ Output data Field(s) output =============== -gprMax produces an output file that has the same name as the input file but with ``.out`` appended. The output file uses the widely-supported `HDF5 `_ format which was designed to store and organize large amounts of numerical data. There are a number of free tools available to read HDF5 files. Also MATLAB has high- and low-level functions for reading and writing HDF5 files, i.e. ``h5info`` and ``h5disp`` are useful for returning information and displaying the contents of HDF5 files respectively. gprMax includes some Python modules (in the ``tools`` package) to help you view output data. These are documented in the :ref:`tools section `. +gprMax produces an output file that has the same name as the input file but with ``.h5`` appended. The output file uses the widely-supported `HDF5 `_ format which was designed to store and organize large amounts of numerical data. There are a number of free tools available to read HDF5 files. Also MATLAB has high- and low-level functions for reading and writing HDF5 files, i.e. ``h5info`` and ``h5disp`` are useful for returning information and displaying the contents of HDF5 files respectively. gprMax includes some Python modules (in the ``tools`` package) to help you view output data. These are documented in the :ref:`tools section `. File structure -------------- diff --git a/docs/source/plotting.rst b/docs/source/plotting.rst index 175dc109..b05e9bb8 100644 --- a/docs/source/plotting.rst +++ b/docs/source/plotting.rst @@ -28,7 +28,7 @@ For example to plot the ``Ez`` output component with it's FFT: .. code-block:: none - python -m tools.plot_Ascan my_outputfile.out --outputs Ez -fft + python -m tools.plot_Ascan my_outputfile.h5 --outputs Ez -fft B-scans ======= @@ -239,5 +239,3 @@ where :math:`R_c` is set to :math:`0.25` and :math:`f` is the frequency. .. figure:: images/contsine.png Example of the ``contsine`` waveform - time domain and power spectrum. - - diff --git a/docs/source/user_libs_antenna_patterns.rst b/docs/source/user_libs_antenna_patterns.rst index 8dee0649..ad85052e 100644 --- a/docs/source/user_libs_antenna_patterns.rst +++ b/docs/source/user_libs_antenna_patterns.rst @@ -39,8 +39,8 @@ How to use the module ===================== * Firstly you should familiarise yourself with the example model input file. Edit the input file as desired and run one of the simulations for either E-plane or H-plane patterns. -* Whilst the simulation is running edit the 'user configurable paramters' sections of the ``initial_save.py`` and ``plot_fields.py`` modules to match the setup of the simulation. -* Once the simulation has completed, run the ``initial_save.py`` module on the output file, e.g. for the E-plane ``python -m user_libs.antenna_patterns.initial_save user_models/antenna_like_GSSI_1500_patterns_E_Er5.out``. This will produce a Numpy file containing the field pattern data. +* Whilst the simulation is running edit the 'user configurable parameters' sections of the ``initial_save.py`` and ``plot_fields.py`` modules to match the setup of the simulation. +* Once the simulation has completed, run the ``initial_save.py`` module on the output file, e.g. for the E-plane ``python -m user_libs.antenna_patterns.initial_save user_models/antenna_like_GSSI_1500_patterns_E_Er5.h5``. This will produce a Numpy file containing the field pattern data. * Plot the field pattern data by running the ``plot_fields.py`` module on the Numpy file, e.g. for the E-plane ``python -m user_libs.antenna_patterns.plot_fields user_models/antenna_like_GSSI_1500_patterns_E_Er5.npy`` .. tip:: diff --git a/docs/source/utils.rst b/docs/source/utils.rst index 799f0093..bba65a1f 100644 --- a/docs/source/utils.rst +++ b/docs/source/utils.rst @@ -29,7 +29,7 @@ gprMax produces a separate output file for each trace (A-scan) in a B-scan. This 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`` +* ``basefilename`` is the base name file of the output file series, e.g. for ``myoutput1.h5``, ``myoutput2.h5`` the base file name would be ``myoutput`` * ``remove-files`` is an optional argument (flag) that when given will remove the separate output files after the merge.