simulate

Model.simulate(dataset: str, parameters: ParameterGroup, axes: dict[str, np.ndarray] = None, clp: np.ndarray | xr.DataArray = None, noise: bool = False, noise_std_dev: float = 1.0, noise_seed: int = None) → xr.Dataset[source]

Simulates the model.

Parameters

  • dataset – Label of the dataset to simulate.

  • parameter – The parameters for the simulation.

  • axes – A dictionary with axes for simulation.

  • clp – Conditionally linear parameters. Used instead of model.global_matrix if provided.

  • noise – If True noise is added to the simulated data.

  • noise_std_dev – The standard deviation of the noise.

  • noise_seed – Seed for the noise.