swiftest.Simulation.set_output_files

swiftest.Simulation.set_output_files#

Simulation.set_output_files(output_file_type=None, output_file_name=None, output_format=None, restart=None, simdir=None, **kwargs)[source]#

Sets the output file parameters in the parameter dictionary.

Parameters:

  • output_file_type ({“NETCDF_DOUBLE”, “NETCDF_FLOAT”,”REAL4”,”REAL8”,”XDR4”,”XDR8”}, optional) – The file type for the outputs of the simulation. Compatible file types depend on the codename argument.

    • Swiftest: Only “NETCDF_DOUBLE” or “NETCDF_FLOAT” supported.

    • Swifter: Only “REAL4”,”REAL8”,”XDR4” or “XDR8” supported.

    • Swift: Only “REAL4” supported.

  • output_file_name (str or path-like, optional) – Name of output file to generate. If not supplied, then one of the default file names are used, depending on the value passed to output_file_type. If one of the NetCDF types are used, the default is “data.nc”. Otherwise, the default is “bin.dat”.

  • output_format ({“XV”,”XVEL”}, optional) – Specifies the format for the data saved to the output file. If “XV” then cartesian position and velocity vectors for all bodies are stored. If “XVEL” then the orbital elements are also stored.

  • restart (bool, optional) – Indicates whether this is a restart of an old run or a new run.

  • simdir (PathLike, optional) – Directory where simulation data will be stored, including the parameter file, initial conditions file, output file

  • **kwargs (Any) – A dictionary of additional keyword argument. This allows this method to be called by the more general set_parameter method, which takes all possible Simulation parameters as arguments, so these are ignored.

Returns:

output_file_dict (dict) – A dictionary containing the requested parameters

Contents