Parameters

class puq.Parameter(*args, **kargs)

Superclass for all Parameter subclasses. For backwards compatibility it can be called directly and will return the proper subclass.

• NormalParameter is returned if dev is set.
• UniformParameter is returned if either min or max is set.
• CustomParameter is returned if pdf or caldata is set.

Parameters:

• name – Name of the parameter. This should be a short name, like a variable.
• description – A longer description of the parameter.
• kargs – Keyword args defined by the distribution.

See also

NormalParameter, UniformParameter, CustomParameter

class puq.CustomParameter(name, description, **kwargs)

Class implementing a Parameter with a Custom distribution.

Parameters:

• name – Name of the parameter. This should be a short name, like a variable.

• description – A longer description of the parameter.

• kwargs – Keyword args. Valid args are:

  Arg	Description
  pdf	PDF
  use_samples	Use data samples attached to pdf (if available)

class puq.ExponParameter(name, description, **kwargs)

Class implementing a Parameter with an Exponential distribution.

Parameters:

• name – Name of the parameter. This should be a short name, like a variable.

• description – A longer description of the parameter.

• kwargs – Keyword args. Valid args are:

  Arg	Description
  rate	The rate parameter. Must be > 0.

See also

ExponPDF

class puq.NormalParameter(name, description, **kwargs)

Class implementing a Parameter with a Normal distribution.

Parameters:

• name – Name of the parameter. This should be a short name, like a variable.

• description – A longer description of the parameter.

• kwargs – Keyword args. Valid args are:

  Arg	Description
  mean	The mean of the distribution
  dev	The standard deviation

class puq.RayleighParameter(name, description, **kwargs)

Class implementing a Parameter with a Rayleigh distribution.

Parameters:

• name – Name of the parameter. This should be a short name, like a variable.

• description – A longer description of the parameter.

• kwargs – Keyword args. Valid args are:

  Arg	Description
  scale	The scale. Must be > 0.

See also

RayleighPDF

class puq.UniformParameter(name, description, **kwargs)

Class implementing a Parameter with a Uniform distribution.

Parameters:

• name – Name of the parameter. This should be a short name, like a variable.

• description – A longer description of the parameter.

• kwargs – Keyword args. Valid args are:

  Property	Description
  mean	The mean of the distribution
  max	The maximum
  min	The minimum

You must specify two of the above properties. If you give all three, they will be checked for consistency. \(mean = (min + max)/2\)

class puq.WeibullParameter(name, description, **kwargs)

Class implementing a Parameter with a Weibull distribution.

Parameters:

• name – Name of the parameter. This should be a short name, like a variable.

• description – A longer description of the parameter.

• kwargs – Keyword args. Valid args are:

  Arg	Description
  shape	The shape. Must be > 0.
  scale	The scale. Must be > 0.

See also

WeibullPDF

class puq.PSweep(iteration_cb=None)

run(sweep)

Gets the parameters then adds the command plus parameters to the host object job list. Then tells the host to run. After all jobs have completed, collect the data and call analyze(). If iteration_cb is defined, call it.

Returns True on success.