unifhy.Model.simulate

Model.simulate(dumping_frequency=None, overwrite=True)

Run model simulation over period defined in its components’ timedomains.

Parameters

dumping_frequency: datetime.timedelta object, optional

The frequency at which model snapshots must be stored in a dump file. These snapshots can be used to restart a Model from a particular point in time. If not provided, set to default None (i.e. no snapshot stored).

Note, the frequency is to be understood in a simulation time context, not in a computational time context.

Parameter example:

dumping_frequency=datetime.timedelta(weeks=4)

overwrite: bool, optional

Whether existing files should be overwritten if they feature the same name as files about to be written by the model. If not provided, set to default True.