ProgServer

prog_server.is_running() → bool

Check if the server is running.

prog_server.run(**kwargs)

Start the server and block until it is stopped.

Parameters

• host (str, optional) – Server host. Defaults to ‘127.0.0.1’.

• port (int, optional) – Server port. Defaults to 8555.

• debug (bool, optional) – If the server is started in debug mode

• models (dict[str, PrognosticsModel]) – a dictionary of extra models to consider. The key is the name used to identify it.

• predictors (dict[str, predictors.Predictor]) – a dictionary of extra predictors to consider. The key is the name used to identify it.

• state_estimators (dict[str, state_estimators.StateEstimator]) – a dictionary of extra estimators to consider. The key is the name used to identify it.

prog_server.start(timeout: float = 10, **kwargs) → None

Start the server (not blocking).

Parameters

timeout (float, optional) – Timeout in seconds for starting the service

Keyword Arguments

• host (str, optional) – Server host. Defaults to ‘127.0.0.1’.

• port (int, optional) – Server port. Defaults to 8555.

• debug (bool, optional) – If the server is started in debug mode

• models (dict[str, PrognosticsModel]) – a dictionary of extra models to consider. The key is the name used to identify it.

• predictors (dict[str, predictors.Predictor]) – a dictionary of extra predictors to consider. The key is the name used to identify it.

• state_estimators (dict[str, state_estimators.StateEstimator]) – a dictionary of extra estimators to consider. The key is the name used to identify it.

prog_server.stop(timeout: float = 10) → None

Stop the server.

Parameters

timeout (float, optional) – Timeout in seconds for starting the service