diff --git a/docs/source/accelerators.rst b/docs/source/accelerators.rst index e60bfff2..d5166b39 100644 --- a/docs/source/accelerators.rst +++ b/docs/source/accelerators.rst @@ -1,8 +1,8 @@ .. _accelerators: -************ -Accelerators -************ +********************************* +Accelerators - OpenMP/CUDA/OpenCL +********************************* The most computationally intensive parts of gprMax, which are the FDTD solver loops, have been parallelised using: diff --git a/docs/source/benchmarking.rst b/docs/source/benchmarking.rst index 82c5f653..f8a8b80b 100644 --- a/docs/source/benchmarking.rst +++ b/docs/source/benchmarking.rst @@ -1,15 +1,15 @@ .. _benchmarking: -************************ -Performance benchmarking -************************ +************ +Benchmarking +************ This section provides information and results from performance benchmarking of gprMax. How to benchmark? ================= -The following simple models (found in the ``tests/benchmarking`` sub-package) can be used to benchmark gprMax on your own system. The models feature different domain sizes (from 100^3 to 800^3 cells) and contain a simple Hertzian dipole source in free space. The following shows an example of the 100^3 cell model: +The following simple models (found in the ``testing/benchmarking`` sub-package) can be used to benchmark gprMax on your own system. The models feature different domain sizes (from 100^3 to 800^3 cells) and contain a simple Hertzian dipole source in free space. The following shows an example of the 100^3 cell model: .. literalinclude:: ../../testing/benchmarking/bench_100x100x100.in :language: none diff --git a/docs/source/hpc.rst b/docs/source/hpc.rst index fe6716fa..4443efdd 100644 --- a/docs/source/hpc.rst +++ b/docs/source/hpc.rst @@ -1,10 +1,10 @@ .. _hpc: -******************************** -High-performance computing (HPC) -******************************** +************************** +High-performance computing +************************** -HPC environments usually require jobs to be submitted to a queue using a job script. The following are examples of job scripts for a HPC environment that uses `Open Grid Scheduler/Grid Engine `_, and are intended as general guidance to help you get started. Using gprMax in an HPC environment is heavily dependent on the configuration of your specific HPC/cluster, e.g. the names of parallel environments (``-pe``) and compiler modules will depend on how they were defined by your system administrator. +High-performance computing (HPC) environments usually require jobs to be submitted to a queue using a job script. The following are examples of job scripts for a HPC environment that uses `Open Grid Scheduler/Grid Engine `_, and are intended as general guidance to help you get started. Using gprMax in an HPC environment is heavily dependent on the configuration of your specific HPC/cluster, e.g. the names of parallel environments (``-pe``) and compiler modules will depend on how they were defined by your system administrator. OpenMP example diff --git a/docs/source/input_api.rst b/docs/source/input_api.rst index 60841f9b..8357890d 100644 --- a/docs/source/input_api.rst +++ b/docs/source/input_api.rst @@ -1,8 +1,8 @@ .. _api: -******************************* -Model building using Python API -******************************* +*************************** +Model building - Python API +*************************** Introduction ============ diff --git a/docs/source/input_hash_cmds.rst b/docs/source/input_hash_cmds.rst index b38a0dbc..f589cfd2 100644 --- a/docs/source/input_hash_cmds.rst +++ b/docs/source/input_hash_cmds.rst @@ -1,8 +1,8 @@ .. _commands: -********************************** -Model building using hash commands -********************************** +****************************** +Model building - hash commands +****************************** An input file has to be supplied to gprMax which should contain all the necessary information to run a GPR model. The input file is an ASCII text file which can be prepared with any text editor or word-processing program. In the input file the hash character (``#``) is reserved and is used to denote the beginning of a command which will be passed to gprMax. The general syntax of commands is: