5.1.3. gemini_model.model_abstract

Abstract base interface for Gemini simulation models.

All concrete models should inherit from Model and implement the parameter update, state initialization/update, output calculation, and output retrieval methods shown below.

Classes

Model()

Abstract base class for discrete state-space models.

class gemini_model.model_abstract.Model

Bases: ABC

Abstract base class for discrete state-space models.

Model initialization.

abstract calculate_output(u, x)

Calculate output based on input u and state x.

abstract get_output()

Get output of the model.

abstract initialize_state(x)

Generate an initial state based on user parameters.

abstract update_parameters(parameters)

Update model parameters.

Parameters:

parameters (dict) – Parameters dict as defined by the model.

abstract update_state(u, x)

Update the state based on input u and state x.