swiftest.Simulation.get_distance_range

swiftest.Simulation.get_distance_range#

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

Returns a subset of the parameter dictionary containing the current values of the distance range parameters.

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 features to extract. Default is all of [โ€œrminโ€, โ€œrmaxโ€]

  • **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:

range_dict (dict) โ€“ A dictionary containing the requested parameters.