From 717e99018f70eda0e8d56eb51df41ba88742de68 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Mon, 29 Feb 2016 16:05:03 +0000 Subject: [PATCH] Added notes on benchmark command line argument. --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 77861e7d..140df0e8 100644 --- a/README.rst +++ b/README.rst @@ -126,7 +126,8 @@ There are optional command line arguments for gprMax: * ``--geometry-only`` will build a model and produce any geometry views but will not run the simulation. This option is useful for checking the geometry of the model is correct. * ``-n`` is used along with a integer number to specify the number of times to run the input file. This option can be used to run a series of models, e.g. to create a B-scan that uses an antenna model. -* ``-mpi`` is a flag to turn on Message Passing Interface (MPI) task farm functionality. This option is most usefully combined with ``-n`` to allow individual models to be farmed out using MPI. For further details see the Parallel performance section (http://docs.gprmax.com/en/latest/openmp_mpi.html#parallelism-openmp-mpi). +* ``-mpi`` is a flag to turn on Message Passing Interface (MPI) task farm functionality. This option is most usefully combined with ``-n`` to allow individual models to be farmed out using MPI. For further details see the Parallel performance section (http://docs.gprmax.com/en/latest/openmp_mpi.html). +* ``-benchmark`` is a flag to turn on benchmarking mode. This can be used to benchmark the threading (parallel) performance of gprMax on different hardware. For further details see the benchmarking section (http://docs.gprmax.com/en/latest/benchmarking.html) * ``--write-python`` will write an input file after any Python code blocks in the original input file have been processed. * ``-h`` or ``--help`` can be used to get help on command line options.