unifhy.Model.initialise_transfers_from_dump

Model.initialise_transfers_from_dump(dump_file, at=None)

Initialise the transfers of the Exchanger from a dump file.

Parameters

dump_file: str

A string providing the path to the netCDF dump file containing values to be used as initial conditions for the transfers of the Exchanger.

at: datetime object, optional

The snapshot in time to be used for the initial conditions. Must be any datetime type (except numpy.datetime64). Must be contained in the ‘time’ variable in dump_file. If not provided, the last index in the ‘time’ variable in dump_file will be used.

Note: if a datetime is provided, there is no enforcement of the fact that this datetime must correspond to the initial datetime in the simulation period for the Component, and it is only used as a means to select a specific snapshot in time amongst the ones available in the dump file.

Returns

datetime object

The snapshot in time that was used for the initial conditions.