From: Steven Baltakatei Sandoval Date: Wed, 4 Aug 2021 11:46:38 +0000 (+0000) Subject: doc(unitproc/.../sleepRand.py): Add comments X-Git-Tag: 0.5.0~48 X-Git-Url: https://zdv2.bktei.com/gitweb/BK-2020-03.git/commitdiff_plain/b914c4010b87ea0f988556d3f9bd982ba28a43d4?ds=sidebyside doc(unitproc/.../sleepRand.py): Add comments --- diff --git a/unitproc/python/sleepRand.py b/unitproc/python/sleepRand.py index 76a32e1..27e98d7 100755 --- a/unitproc/python/sleepRand.py +++ b/unitproc/python/sleepRand.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # Desc: Pauses a random amount of time. Random distribution is inverse gaussian. -# Version: 0.0.1 +# Version: 0.0.2 # Depends: python 3.7.3 # Usage: ./sleepRand.py arg1 # Input: arg1: float seconds (mean of inverse gaussian distribution) @@ -11,6 +11,10 @@ import math, time, random, sys # Define functions def randInvGau(mu, lam): """Returns random variate of inverse gaussian distribution""" + # input: mu: mean of inverse gaussian distribution + # lam: shape parameter + # output: float sampled from inv. gaus. with range 0 to infinity, mean mu + # example: sample = float(randInvGau(1.0,4.0)); # Ref/Attrib: doi:10.1080/00031305.1976.10479147 nu = random.gauss(0,1); y = nu ** 2; @@ -38,4 +42,5 @@ delay = randInvGau(desMean, desMean * lambdaFactor); # Sleep time.sleep(float(delay)); - +# Author: Steven Baltakatei Sandoal +# License: GPLv3+