From d70b680c81bdc8dbe331197195852ae0504a9fa2 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Wed, 31 Jan 2018 23:03:15 +0100 Subject: [PATCH] Changed white space to underscore in path names for some tools. --- .gitattributes | 2 +- docs/source/openmp_mpi.rst | 13 ++++++------- tools/{HPC scripts => HPC_scripts}/gprmax_omp.sh | 0 .../gprmax_omp_jobarray.sh | 0 .../{HPC scripts => HPC_scripts}/gprmax_omp_mpi.sh | 0 .../README.rst | 0 .../cylinder_half_space_geo.png | Bin .../example_Ascan_2D.ipynb | 0 .../example_Bscan_2D.ipynb | 0 .../plot_Ascan.ipynb | 0 .../plot_Bscan.ipynb | 0 .../plot_antenna_params.ipynb | 0 .../plot_source_wave.ipynb | 0 .../{MATLAB scripts => MATLAB_scripts}/README.rst | 0 .../plot_Ascan.m | 0 .../plot_Bscan.m | 0 16 files changed, 7 insertions(+), 8 deletions(-) rename tools/{HPC scripts => HPC_scripts}/gprmax_omp.sh (100%) rename tools/{HPC scripts => HPC_scripts}/gprmax_omp_jobarray.sh (100%) rename tools/{HPC scripts => HPC_scripts}/gprmax_omp_mpi.sh (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/README.rst (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/cylinder_half_space_geo.png (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/example_Ascan_2D.ipynb (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/example_Bscan_2D.ipynb (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/plot_Ascan.ipynb (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/plot_Bscan.ipynb (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/plot_antenna_params.ipynb (100%) rename tools/{Jupyter notebooks => Jupyter_notebooks}/plot_source_wave.ipynb (100%) rename tools/{MATLAB scripts => MATLAB_scripts}/README.rst (100%) rename tools/{MATLAB scripts => MATLAB_scripts}/plot_Ascan.m (100%) rename tools/{MATLAB scripts => MATLAB_scripts}/plot_Bscan.m (100%) diff --git a/.gitattributes b/.gitattributes index c07f914c..d4d60d71 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -gprMax/tools/Jupyter\ notebooks/* linguist-vendored +gprMax/tools/Jupyter_notebooks/* linguist-vendored diff --git a/docs/source/openmp_mpi.rst b/docs/source/openmp_mpi.rst index 0e9efd02..9dedb269 100644 --- a/docs/source/openmp_mpi.rst +++ b/docs/source/openmp_mpi.rst @@ -27,11 +27,11 @@ HPC environments usually require jobs to be submitted to a queue using a job scr OpenMP example -------------- -:download:`gprmax_omp.sh <../../tools/HPC scripts/gprmax_omp.sh>` +:download:`gprmax_omp.sh <../../tools/HPC_scripts/gprmax_omp.sh>` Here is an example of a job script for running models, e.g. A-scans to make a B-scan, one after another on a single cluster node. This is not as beneficial as the OpenMP/MPI example, but it can be a helpful starting point when getting the software running in your HPC environment. The behaviour of most of the variables is explained in the comments in the script. -.. literalinclude:: ../../tools/HPC scripts/gprmax_omp.sh +.. literalinclude:: ../../tools/HPC_scripts/gprmax_omp.sh :language: bash :linenos: @@ -41,11 +41,11 @@ In this example 10 models will be run one after another on a single node of the OpenMP/MPI example ------------------ -:download:`gprmax_omp_mpi.sh <../../tools/HPC scripts/gprmax_omp_mpi.sh>` +:download:`gprmax_omp_mpi.sh <../../tools/HPC_scripts/gprmax_omp_mpi.sh>` Here is an example of a job script for running models, e.g. A-scans to make a B-scan, distributed as independent tasks in a HPC environment using MPI. The behaviour of most of the variables is explained in the comments in the script. -.. literalinclude:: ../../tools/HPC scripts/gprmax_omp_mpi.sh +.. literalinclude:: ../../tools/HPC_scripts/gprmax_omp_mpi.sh :language: bash :linenos: @@ -59,11 +59,11 @@ The ``NSLOTS`` variable which is required to set the total number of slots/cores Job array example ----------------- -:download:`gprmax_omp_jobarray.sh <../../tools/HPC scripts/gprmax_omp_jobarray.sh>` +:download:`gprmax_omp_jobarray.sh <../../tools/HPC_scripts/gprmax_omp_jobarray.sh>` Here is an example of a job script for running models, e.g. A-scans to make a B-scan, using the job array functionality of Open Grid Scheduler/Grid Engine. A job array is a single submit script that is run multiple times. It has similar functionality, for gprMax, to using the aforementioned MPI task farm. The behaviour of most of the variables is explained in the comments in the script. -.. literalinclude:: ../../tools/HPC scripts/gprmax_omp_jobarray.sh +.. literalinclude:: ../../tools/HPC_scripts/gprmax_omp_jobarray.sh :language: bash :linenos: @@ -86,4 +86,3 @@ Eddie is the `Edinburgh Compute and Data Facility (ECDF)