From 101111a13782681aaad63ebf87eca5c6280be86a Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Thu, 24 Mar 2016 15:43:55 +0000 Subject: [PATCH] Added note on not using inputfile_old2new mode for old 2D models. --- docs/source/faqs.rst | 2 +- docs/source/features.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/faqs.rst b/docs/source/faqs.rst index b4ade0d4..16ddcc40 100644 --- a/docs/source/faqs.rst +++ b/docs/source/faqs.rst @@ -20,7 +20,7 @@ No, but it can be beneficial to know a little Python. We have made it easier to Yes, MATLAB has built-in functions to read HDF5 files (http://uk.mathworks.com/help/matlab/high-level-functions.html). **But converting my input file from the old version of gprMax will be really painful** -Hopefully not! We have provided a Python script to help you convert input files from the old version of gprMax to use syntax introduced in version 3. +Hopefully not! We have provided a Python module to help you convert input files of 3D models from the old version of gprMax to use syntax introduced in version 3. Please note this module does not currently convert old 2D model input files. **How do I choose a spatial resolution for my simulation?** Spatial resolution should be chosen to mitigate numerical dispersion and to adequately resolve geometry in your simulation. :ref:`A 2D example of modelling a metal cylinder in a dielectric ` provides guidance on how to determine spatial resolution. diff --git a/docs/source/features.rst b/docs/source/features.rst index 8f6e7f70..db309138 100644 --- a/docs/source/features.rst +++ b/docs/source/features.rst @@ -81,7 +81,7 @@ There are commands from previous versions of gprMax that are planned for this ve Migrating old input files ------------------------- -gprMax includes a Python module (in the ``tools`` package) to help you migrate old input files, written for previous versions of gprMax, to the syntax of the new commands. The module will do its best to convert the old file and write a new one, however, you should still carefully check the new file to make sure it is what you intended! Usage (from the top-level gprMax directory) is: ``python -m tools.inputfile_old2new my_old_inputfile.in``. +gprMax includes a Python module (in the ``tools`` package) to help you migrate old input files, written for previous versions of gprMax, to the syntax of the new commands. The module has been written for 3D models and will not (currently) work with old input files of 2D models. The module will do its best to convert the old file and write a new one, however, you should still carefully check the new file to make sure it is what you intended! Usage (from the top-level gprMax directory) is: ``python -m tools.inputfile_old2new my_old_inputfile.in``. Key features