From 3a72c2f8a3234d156d20a19c2c5f632bd3df461a Mon Sep 17 00:00:00 2001 From: vetlewi Date: Wed, 27 Oct 2021 13:48:21 +0200 Subject: [PATCH] Added plot example to docstring --- ompy/dist/fermi_dirac.py | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/ompy/dist/fermi_dirac.py b/ompy/dist/fermi_dirac.py index b7146f98..70cb3e4e 100644 --- a/ompy/dist/fermi_dirac.py +++ b/ompy/dist/fermi_dirac.py @@ -24,11 +24,27 @@ class FermiDirac(PositiveContinuous): .. plot:: + import matplotlib.pyplot as plt + import numpy as np + + x = np.linspace(0, 5., 1000) + lam = [1.0, 10., 25.] + mu = [0.5, 1.0, 2.0] + + def pdf(x, lam, mu): + return (lam/np.log(1 + np.exp(lam*mu))*(1/(np.exp(lam*(x-mu)) + 1)) + + for l in lam: + for m in mu: + pdf = pdf(x, l, m) + plt.plot(x, pdf, label=f"$\lambda = {l}$, $\mu = {m}$") + plt.xlabel("x", fontsize=12) + plt.ylabel("f(x)", fontsize=12) + plt.legend(loc=1) + plt.show() ======== ============================ Support :math:`x \in [0, \infty)` - Mean - Variance ======== ============================ @@ -38,6 +54,14 @@ class FermiDirac(PositiveContinuous): Rate of decay at mu (lam > 0) mu: float Decay position + + Examples + -------- + .. code-block:: python + + with pm.Model(): + x = ompy.FermiDirac('x', lam=10.0, mu=1.2) + """ def __init__(self, lam, mu, *args, **kwargs):