swiftest.Simulation.save

swiftest.Simulation.save#

Simulation.save(codename=None, param_file=None, param=None, framenum=-1, **kwargs)[source]#

Saves an xarray dataset to a set of input files.

Parameters:
  • codename ({“Swiftest”, “Swifter”, “Swift”}, optional) – Alternative name of the n-body code that the parameter file will be formatted for. Defaults to current instance variable self.codename

  • param_file (str or path-like, optional) – Alternative file name of the input parameter file. Defaults to current instance variable self.param_file

  • param (Dict, optional) – An alternative parameter dictionary to write out. Defaults to the current instance variable self.param

  • framenum (int Default=-1) – Time frame to use to generate the initial conditions. If this argument is not passed, the default is to use the last frame in the dataset.

  • **kwargs (Any) – A dictionary of additional keyword argument.

Returns:

None