From 8055f1013c4f445fd038fc5cface8deb25a4ee31 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Tue, 15 Dec 2015 17:41:21 +0000 Subject: [PATCH] Added information on structure of fitness metric functions. --- user_libs/optimisations/taguchi_fitness.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/user_libs/optimisations/taguchi_fitness.py b/user_libs/optimisations/taguchi_fitness.py index f0dce92c..5aa76765 100644 --- a/user_libs/optimisations/taguchi_fitness.py +++ b/user_libs/optimisations/taguchi_fitness.py @@ -10,9 +10,16 @@ import h5py from gprMax.constants import floattype +"""This module contains fitness metric functions that can be used with the Taguchi optimisation method. + + All fitness functions must take two arguments and return a single fitness value. + The first argument should be the name of the output file + The second argument is a list which can contain any number of additional arguments, e.g. names (IDs) of outputs (rxs) from input file +""" + def fitness_max(filename, outputnames): - """Return the maximum value from specific outputs in a file. + """Return the maximum value from a specific output in the input file. Args: filename (str): Name of output file