add poisson, Geometric, and Binomial dists to the docs. ready for v2.3.7

Author: geraintpalmer

CHANGES.rst

@@ -1,7 +1,10 @@
 History
 -------
 
-+ **v.2.3.6 (2023-02-16)**
++ **v2.3.7 (2023-04-06)**
+    + Adds Poisson, Geometric, and Binomial distributions fro batching.
+
++ **v2.3.6 (2023-02-16)**
     + Writes a data record for interrupted services caused by server schedules.
     + Raises an error when an inconsistant number of custom node classes are used.
 

ciw/version.py

@@ -1 +1 @@
-__version__ = "2.3.6"
+__version__ = "2.3.7"

docs/Guides/batching.rst

@@ -46,6 +46,9 @@ Note:
      + :code:`Empirical`
      + :code:`Pmf`
      + :code:`Sequential`
+     + :code:`Poisson`
+     + :code:`Geometric`
+     + :code:`Binomial`
   + If the keyword :code:`batching_distributions` is omitted, then no batching is assumed. That is only one customer arrives at a time. Equivalent to :code:`ciw.dists.Deterministic(1)`.
   + If some nodes/customer classes require no batching, but others do, please use :code:`ciw.dists.Deterministic(1)`.
   + Batch arrivals may lead to :ref:`simultaneous events <simultaneous_events>`, please take care.

docs/Reference/distributions.rst

@@ -26,6 +26,9 @@ The following are currently supported:
 - :ref:`hypererlang_dist`
 - :ref:`coxian_dist`
 - :ref:`poissonintervals_dist`
+- :ref:`poisson_dist`
+- :ref:`geometric_dist`
+- :ref:`binomial_dist`
 - :ref:`no_arrivals`
 
 
@@ -274,6 +277,42 @@ For Exponential arrivals with rate 3 in the time interval (0, 4.8), rate 5.5 in
     ciw.dists.PoissonIntervals(rates=[3, 5.5, 0.1], endpoints=[4.8, 9.3, 12], max_sample_date=100)
 
 
+.. _poisson_dist:
+
+------------------------
+The Poisson Distribution
+------------------------
+
+The Poisson distribution samples a random integer from the Poisson distribution with mean :math:`\lambda`.
+Write an Poisson distribution with mean `1.7` as follows::
+
+    ciw.dists.Poisson(rate=1.7)
+
+
+.. _geometric_dist:
+
+--------------------------
+The Geometric Distribution
+--------------------------
+
+The Geometric distribution samples a random integer from the Geometric distribution with parameter :math:`p`. That is, the number of Bernoulli trials until a success, when each independent Bernoulli trial has probability :math:`p` of succes.
+Write an Geometric distribution with success probability of `0.3` as follows::
+
+    ciw.dists.Geometric(prob=0.3)
+
+
+.. _binomial_dist:
+
+-------------------------
+The Binomial Distribution
+-------------------------
+
+The Binomial distribution samples a random integer from the Binomial distribution with parameters :math:`n` and :math:`p`. That is, the number of successful Bernoulli trials out of a total of :math:`n` trials, when each independent Bernoulli trial has probability :math:`p` of succes.
+Write an Geometric distribution with success probability of `0.3` and `20` trials as follows::
+
+    ciw.dists.Binomial(n=20, prob=0.3)
+
+
 .. _no_arrivals:
 
 -----------

docs/conf.py

@@ -70,7 +70,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used: