Python_interface_library

Module providing the MoDeNa python interface. More...

Data Structures
class	python.Strategy.InitialisationStrategy
	Parent class for the initialisation strategies. More...
class	python.Strategy.OutOfBoundsStrategy
	Parent class for the out of bounds strategies. More...
class	python.Strategy.ImproveErrorStrategy
	Base class for strategies 'fixing' the error of a surrogate model. More...
class	python.Strategy.ParameterFittingStrategy
	Base Class for creating parameter fitting strategies. More...
class	python.Strategy.SamplingStrategy
	Base class for Sampling strategies (DoE). More...
class	python.Strategy.InitialPoints
	Class for initialisation of a surrogate model by fitting it to user-specified points. More...
class	python.Strategy.InitialData
	Class initialising a SurrogateModel given a dataset of input-output relations. More...
class	python.Strategy.EmptyInitialisationStrategy
	Empty initialisation strategy, used by Forward Mapping Models. More...
class	python.Strategy.ExtendSpaceStochasticSampling
	Class for extending the design space using stochastic sampling. More...
class	python.Strategy.StochasticSampling
	Design of experiments class, Monte Carlo sampling. More...
class	python.Strategy.NonLinFitWithErrorContol
	Parameter fitting class, non-linear least squares regression. More...
class	python.Strategy.NonLinFitToPointWithSmallestError
	Performs parameter fitting of a set of samples and returns the parameters that yield the smallest error. More...
class	python.Strategy.Initialisation
	A FireTask that performs the initialisation. More...
class	python.Strategy.ParameterFitting
	A FireTask that performs parameter fitting. More...
class	python.Strategy.InitialDataPoints
	Pushes all "points" to the next firework. More...
class	python.Strategy.OutOfBounds
class	python.Strategy.ParametersNotValid
class	python.Strategy.TerminateWorkflow
class	python.Strategy.ModifyWorkflow
class	python.Strategy.ModenaFireTask
class	python.Strategy.BackwardMappingScriptTask
	A FireTask that starts a macroscopic code and catches its return code. More...
class	python.SurrogateModel.ArgPosNotFound
class	python.SurrogateModel.EmbDoc
	Class wrapper for DynamicEmbeddedDocument from MongeEngine. More...
class	python.SurrogateModel.GrowingList
	Class list that is automatically extended when index is out of range. More...
class	python.SurrogateModel.IndexSet
class	python.SurrogateModel.MinMax
class	python.SurrogateModel.MinMaxOpt
class	python.SurrogateModel.MinMaxArgPos
class	python.SurrogateModel.MinMaxArgPosOpt
class	python.SurrogateModel.IOP
class	python.SurrogateModel.SurrogateFunction
class	python.SurrogateModel.CFunction
	Class for defining Surrogate Functions where the executable code is a C- function. More...
class	python.SurrogateModel.Function
class	python.SurrogateModel.SurrogateModel
class	python.SurrogateModel.ForwardMappingModel
	Class for defining 'forward mapping' models. More...
class	python.SurrogateModel.BackwardMappingModel
	Class for defining 'backward mapping' models. More...

Functions
def	python.SurrogateModel.existsAndHasArgPos (i, name)
	Function checking whether the model inputs corresponds to the arguments. More...
def	python.SurrogateModel.checkAndConvertType (kwargs, name, cls)
	Function checking if the type of the strategy "name" provided by the user is correct, i.e. More...
def	python.SurrogateModel.loadType (obj, name, cls)
	Function that helps loading strategy "name" from model "obj". More...

Detailed Description

Module providing the MoDeNa python interface.

Function Documentation

checkAndConvertType()

def python.SurrogateModel.checkAndConvertType	(		kwargs,
			name,
			cls
	)

Function checking if the type of the strategy "name" provided by the user is correct, i.e.

corresponds to "cls".

@param kwargs (dict) dictionary where
@param name (str) name of strategy
@param cls class type

Definition at line 101 of file SurrogateModel.py.

existsAndHasArgPos()

def python.SurrogateModel.existsAndHasArgPos	(		i,
			name
	)

Function checking whether the model inputs corresponds to the arguments.

Parameters

i	dict, inputs of a surrogate model.
name	str from regex, (.*), function arguments.

Definition at line 87 of file SurrogateModel.py.

loadType()

def python.SurrogateModel.loadType	(		obj,
			name,
			cls
	)

Function that helps loading strategy "name" from model "obj".

Returns an instance of the type "cls" appropriate strategy.

Parameters

obj	(instance) instance of surrogate model
name	(str) name of the strategy
cls	(class type) strategy class type

Returns

instance of a strategy

Definition at line 121 of file SurrogateModel.py.