From e7a5f21442e663603f3a4e37c29d08b9598c6571 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Wed, 4 May 2016 09:39:35 +0100 Subject: [PATCH] More updates to docs for optimisation process. --- README.rst | 2 +- docs/source/user_libs_opt_taguchi.rst | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 01654709..4eb52370 100644 --- a/README.rst +++ b/README.rst @@ -129,7 +129,7 @@ There are optional command line arguments for gprMax: * ``-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) * ``--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. -*``--optimisation-taguchi`` will run a series of simulations using a optimisation process based on Taguchi's method. For further details see the user libraries section (http://docs.gprmax.com/en/latest/user_libs_opt_taguchi.html) +*``--opt-taguchi`` will run a series of simulations using a optimisation process based on Taguchi's method. For further details see the user libraries section (http://docs.gprmax.com/en/latest/user_libs_opt_taguchi.html) * ``--write-processed`` will write an input file after any Python code and include commands in the original input file have been processed. * ``-h`` or ``--help`` can be used to get help on command line options. diff --git a/docs/source/user_libs_opt_taguchi.rst b/docs/source/user_libs_opt_taguchi.rst index 5fe4fa45..972cdccb 100644 --- a/docs/source/user_libs_opt_taguchi.rst +++ b/docs/source/user_libs_opt_taguchi.rst @@ -80,13 +80,16 @@ Parameters and settings for the optimisation process are specified within a spec * ``args``, a dictionary containing arguments to be passed to the fitness function. Within ``args`` there must be a key called ``outputs`` which contains a string or list of the names of one or more outputs in the model. * ``stop``, a value which when exceeded the optimisation should stop. -Optionally a variable called ``maxiterations`` maybe specified within the ``#taguchi`` block which will set a maximum number of iterations after which the optimisation process will terminate irrespective of any other criteria. +Optionally a variable called ``maxiterations`` maybe specified within the ``#taguchi``/``#end_taguchi`` block which will set a maximum number of iterations after which the optimisation process will terminate irrespective of any other criteria. How to use the package ====================== -The package requires ``#python`` and ``#end_python`` to be used in the input file, as well as ``#taguchi`` and ``#end_taguchi`` for specifying parameters and setting for the optimisation process. A Taguchi optimisation is run using the command line option ``--optimisation-taguchi``. +The package requires ``#python`` and ``#end_python`` to be used in the input file, as well as ``#taguchi`` and ``#end_taguchi`` for specifying parameters and setting for the optimisation process. A Taguchi optimisation is run using the command line option ``--opt-taguchi``. Example -------- \ No newline at end of file +------- + +The following example demonstrates using the Taguchi optimisation process to optimise values of loading resistors used in a bowtie antenna. The bowtie design features 3 slots in each arm of the bowtie where loading resistors are placed, and a substrate with a perimittivity of 4.8 is used. The antenna is modelled in free space, and an output point (the electric field value) is specified at a distance of 60 mm from the feed of the bowtie. +