unifhy.Model.spin_up

Model.spin_up(start, end, cycles=1, dumping_frequency=None, overwrite=True, _cycle_origin_no=0)

Run model spin-up simulation to initialise states of each Component of the Model.

Parameters

start, end: datetime.datetime object

The start and the end of the spin-up simulation. Their calendar and units are assumed to be the ones of the model Components that will be spun up. Note, the end parameter refers to the end of the last timestep in the spin-up period.

Parameter example:

start=datetime.datetime(2019, 1, 1)

Parameter example:

end=datetime.datetime(2020, 1, 1)

cycles: int, optional

The number of repetitions of the spin-up simulation. If not provided, set to default 1 (cycle).

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=10)

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.