virtualargofleet.VirtualFleet.simulate#

VirtualFleet.simulate(duration, step=datetime.timedelta(seconds=300), record=datetime.timedelta(seconds=3600), output=True, verbose_progress=True, restart=False, **kwargs)[source]#

Execute a Virtual Fleet simulation

Parameters:

  • duration (datetime.timedelta,) – Length of the simulation

  • step (datetime.timedelta, default=5 minutes) – Time step for the computation

  • record (datetime.timedelta, default=1 hours) – Time step for writing the output

  • output (bool, default=False) – Should the simulation trajectories be saved on file or not

  • output_file (str) – Name of the zarr file where to store simulation results

  • output_folder (str) – Name of folder where to store the ‘output_file’ zarr archive

Return type:

self