sarkas.tools.observables.VelocityDistribution.setup#

VelocityDistribution.setup(params, phase=None, no_slices=None, hist_kwargs=None, max_no_moment=None, multi_run_average=None, dimensional_average=None, runs=1, curve_fit_kwargs=None, **kwargs)[source]#

Assign attributes from simulation’s parameters.

Parameters
  • params (sarkas.core.Parameters) – Simulation’s parameters.

  • phase (str, optional) – Phase to compute. Default = ‘production’.

  • no_slices (int, optional)

  • max_no_moment (int, optional) – Maximum number of moments to calculate. Default = 6.

  • hist_kwargs (dict, optional) – Dictionary of keyword arguments to pass to histogram for the calculation of the distributions.

  • curve_fit_kwargs (dict, optional) – Dictionary of keyword arguments to pass to scipy.curve_fit for fitting of Hermite coefficients.

  • **kwargs – These will overwrite any sarkas.core.Parameters or default sarkas.tools.observables.Observable attributes and/or add new ones.