pytams.fmodel

Module Contents

Classes

ForwardModel

A template class for the stochastic forward model.
exception pytams.fmodel.ForwardModelError[source]

Bases: Exception

Exception class for the forward model.

exception pytams.fmodel.TemplateCallError[source]

Bases: ForwardModelError

Template ForwardModel method called !

class pytams.fmodel.ForwardModel(params: dict = None, ioprefix: str = None)[source]

A template class for the stochastic forward model.

Implement the core methods required of the forward model within the TAMS context. Exception are thrown if those functions are not overritten in actual model.

advance(dt: float, forcingAmpl: float) → float[source]

Advance function of the model.

Parameters:

  • dt – the time step size over which to advance

  • forcingAmpl – stochastic multiplicator

Returns:

Some model will not do exactly dt (e.g. sub-stepping) return the actual dt

getCurState()[source]

Return the current state of the model.

setCurState(state)[source]

Set the current state of the model.

score()[source]

Return the model’s current state score.

clear()[source]

Destroy internal data.

classmethod name()[source]

Return a the model name.