From de4ed85e681e5479f9dfb4923992d0358cf30a63 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Thu, 21 Jan 2016 13:33:17 +0000 Subject: [PATCH] Updated some file references. --- README.rst | 2 +- docs/source/faqs.rst | 4 ++-- docs/source/openmp_mpi.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 8bb59fb1..01003c4e 100644 --- a/README.rst +++ b/README.rst @@ -52,7 +52,7 @@ Package overview Installation ============ -You should use the following guidance to install gprMax if you are an end-user (i.e. you don't intend to develop or contribute to the software). Developers should follow the `Installation for developers section of the User guide `: +You should use the following guidance to install gprMax if you are an end-user (i.e. you don't intend to develop or contribute to the software). Developers should follow the :ref:`Installation for developers section of the User guide `: 1. Get the code 2. Install Python and required Python packages diff --git a/docs/source/faqs.rst b/docs/source/faqs.rst index 71b20c21..b4ade0d4 100644 --- a/docs/source/faqs.rst +++ b/docs/source/faqs.rst @@ -17,7 +17,7 @@ gprMax is released under the GNU General Public License v3 or higher (http://www No, but it can be beneficial to know a little Python. We have made it easier to create more complex simulations in gprMax through scripting in the input file. This is achieved by allowing blocks of Python code to be written in the input file which are executed when the file is read by gprMax. **Can I still do all my pre/post-processing for gprMax in MATLAB?** -Yes, we have provided tools to help you read the new HDF5-based output file in MATLAB. +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. @@ -29,4 +29,4 @@ Spatial resolution should be chosen to mitigate numerical dispersion and to adeq gprMax builds objects in a model in the order the objects were specified in the input file, using a layered canvas approach. This means, for example, a cylinder object which comes after a box object in the input file will overwrite the properties of the box object at any locations where they overlap. This approach allows complex geometries to be created using basic object building blocks. **Can I run gprMax on my HPC/cluster?** -Yes. gprMax has been parallelised using OpenMP and features a task farm based on MPI. For more information read the :ref:`section on parallelism. ` \ No newline at end of file +Yes. gprMax has been parallelised using OpenMP and features a task farm based on MPI. For more information read the :ref:`section on parallelism. ` \ No newline at end of file diff --git a/docs/source/openmp_mpi.rst b/docs/source/openmp_mpi.rst index 0cdeec4c..44778855 100644 --- a/docs/source/openmp_mpi.rst +++ b/docs/source/openmp_mpi.rst @@ -1,4 +1,4 @@ -.. _openmp_mpi: +.. _openmp-mpi: ************************ Parallelism - OpenMP/MPI