swiftest.Simulation.get_unit_system

swiftest.Simulation.get_unit_system#

Simulation.get_unit_system(arg_list=None, **kwargs)[source]#

Returns a subset of the parameter dictionary containing the current simulation unit system.

If the verbose option is set in the Simulation object, then it will also print the values.

Parameters:
  • arg_list (str | List[str], optional) – A single string or list of strings containing the names of the simulation unit system Default is all of [“MU”, “DU”, “TU”]

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

Returns:

unit_dict (dict) – A dictionary containing the requested unit conversion parameters