# The Bank: Examples of SimPy Simulation

## Introduction

SimPy is used to develop a simple simulation of a bank with a number of tellers. This Python package provides Processes to model active components such as messages, customers, trucks, and planes. It has three classes to model facilities where congestion might occur: Resources for ordinary queues, Levels for the supply of quantities of material, and Stores for collections of individual items. Only examples of Resources are described here. It also provides Monitors and Tallys to record data like queue lengths and delay times and to calculate simple averages. It uses the standard Python random package to generate random numbers.

Starting with SimPy 2.0 an object-oriented programmer’s interface was added to the package. It is quite compatible with the current procedural approach which is used in the models described here.

SimPy can be obtained from: http://sourceforge.net/projects/simpy. The examples run with SimPy version 1.5 and later. This tutorial is best read with the SimPy Manual or Cheatsheet at your side for reference.

Before attempting to use SimPy you should be familiar with the Python language. In particular you should be able to use classes. Python is free and available for most machine types. You can find out more about it at the Python web site. SimPy is compatible with Python version 2.3 and later.

## A single Customer

In this tutorial we model a simple bank with customers arriving at random. We develop the model step-by-step, starting out simply, and producing a running program at each stage. The programs we develop are available without line numbers and ready to go, in the `bankprograms` directory. Please copy them, run them and improve them - and in the tradition of open-source software suggest your modifications to the SimPy users list. Object-orented versions of all the models are included in the bankprobrams_OO sub directory.

A simulation should always be developed to answer a specific question; in these models we investigate how changing the number of bank servers or tellers might affect the waiting time for customers.

### A Customer arriving at a fixed time

We first model a single customer who arrives at the bank for a visit, looks around at the decor for a time and then leaves. There is no queueing. First we will assume his arrival time and the time he spends in the bank are fixed.

We define a `Customer` class derived from the SimPy `Process` class. We create a `Customer` object, `c` who arrives at the bank at simulation time `5.0` and leaves after a fixed time of `10.0` minutes.

Examine the following listing which is a complete runnable Python script, except for the line numbers. We use comments to divide the script up into sections. This makes for clarity later when the programs get more complicated. At line :an:`1` is a normal Python documentation string; :an:`2` imports the SimPy simulation code.

The `Customer` class definition at :an:`3` defines our customer class and has the required generator method (called `visit` :an:`4`) having a `yield` statement :an:`6`. Such a method is called a Process Execution Method (PEM) in SimPy.

The customer’s `visit` PEM at :an:`4`, models his activities. When he arrives (it will turn out to be a ‘he’ in this model), he will print out the simulation time, `now()`, and his name at :an:`5`. The function `now()` can be used at any time in the simulation to find the current simulation time though it cannot be changed by the programmer. The customer’s name will be set when the customer is created later in the script at :an:`10`.

He then stays in the bank for a fixed simulation time `timeInBank` :an:`6`. This is achieved by the `yield hold,self,timeInBank` statement. This is the first of the special simulation commands that `SimPy` offers.

After a simulation time of `timeInBank`, the program’s execution returns to the line after the `yield` statement at :an:`6`. The customer then prints out the current simulation time and his name at :an:`7`. This completes the declaration of the `Customer` class.

The call `initialize()` at :an:`9` sets up the simulation system ready to receive `activate` calls. At :an:`10`, we create a customer, `c`, with name `Klaus`. All SimPy Processes have a `name` attribute. We `activate` `Klaus` at :an:`11` specifying the object (`c`) to be activated, the call of the action routine (`c.visit(timeInBank = 10.0)`) and that it is to be activated at time 5 (`at = 5.0`). This will activate `Klaus` exactly `5` minutes after the current time, in this case after the start of the simulation at `0.0`. The call of an action routine such as `c.visit` can specify the values of arguments, here the `timeInBank`.

Finally the call of `simulate(until=maxTime)` at :an:`12` will start the simulation. This will run until the simulation time is `maxTime` unless stopped beforehand either by the `stopSimulation()` command or by running out of events to execute (as will happen here). `maxTime` was set to `100.0` at :an:`8`.

     1""" bank01: The single non-random Customer """  # (1)
     2from SimPy.Simulation import *  # (2)
     3
     4## Model components -----------------------------
     5
     6
     7class Customer(Process):  # (3)
     8    """ Customer arrives, looks around and leaves """
     9
    10    def visit(self, timeInBank):  # (4)
    11        print("%2.1f %s  Here I am" % (now(), self.name))  # (5)
    12        yield hold, self, timeInBank  # (6)
    13        print("%2.1f %s  I must leave" % (now(), self.name))  # (7)
    14
    15## Experiment data ------------------------------
    16
    17maxTime = 100.0     # minutes (8)
    18timeInBank = 10.0   # minutes
    19
    20## Model/Experiment ------------------------------
    21
    22initialize()  # (9)
    23c = Customer(name="Klaus")  # (10)
    24activate(c, c.visit(timeInBank), at=5.0)  # (11)
    25simulate(until=maxTime)  # (12)

The short trace printed out by the `print` statements shows the result. The program finishes at simulation time `15.0` because there are no further events to be executed. At the end of the `visit` routine, the customer has no more actions and no other objects or customers are active.

    5.0 Klaus  Here I am
    15.0 Klaus  I must leave

### A Customer arriving at random

Now we extend the model to allow our customer to arrive at a random simulated time though we will keep the time in the bank at 10.0, as before.

The change occurs in line :an:`1` of the program and in lines :an:`2`, :an:`3`, and :an:`4`. In line :an:`1` we import from the standard Python `random` module to give us `expovariate` to generate the random time of arrival. We also import the `seed` function to initialize the random number stream to allow control of the random numbers. In line :an:`2` we provide an initial seed of `99999`. An exponential random variate, `t`, is generated in line :an:`3`. Note that the Python Random module’s `expovariate` function uses the average rate (that is, `1.0/mean`) as the argument. The generated random variate, `t`, is used in line :an:`4` as the `at` argument to the `activate` call.

     1""" bank05: The single Random Customer """
     2from SimPy.Simulation import *
     3from random import expovariate, seed       # (1)
     4
     5## Model components ------------------------
     6
     7
     8class Customer(Process):
     9    """ Customer arrives at a random time,
    10        looks around and then leaves """
    11
    12    def visit(self, timeInBank):
    13        print("%f %s Here I am" % (now(), self.name))
    14        yield hold, self, timeInBank
    15        print("%f %s I must leave" % (now(), self.name))
    16
    17## Experiment data -------------------------
    18
    19maxTime = 100.0    # minutes
    20timeInBank = 10.0
    21## Model/Experiment ------------------------------
    22
    23seed(99999)                   # (2)
    24initialize()
    25c = Customer(name="Klaus")
    26t = expovariate(1.0 / 5.0)      # (3)
    27activate(c, c.visit(timeInBank), at=t)  # (4)
    28simulate(until=maxTime)

The result is shown below. The customer now arrives at about 0.64195, (or 10.58092 if you are not using Python 3). Changing the seed value would change that time.

    0.641954 Klaus Here I am
    10.641954 Klaus I must leave

The display looks pretty untidy. In the next example I will try and make it tidier.

If you are not using Python 3, you output may differ. The output for Python 2 is given in Appendix A.

## More Customers

Our simulation does little so far. To consider a simulation with several customers we return to the simple deterministic model and add more `Customers`.

The program is almost as easy as the first example (A Customer arriving at a fixed time). The main change is in lines :an:`4` to :an:`5` where we create, name, and activate three customers. We also increase the maximum simulation time to `400` (line :an:`3` and referred to in line :an:`6`). Observe that we need only one definition of the `Customer` class and create several objects of that class. These will act quite independently in this model.

Each customer stays for a different `timeinbank` so, instead of setting a common value for this we set it for each customer. The customers are started at different times (using `at=`). `Tony's` activation time occurs before `Klaus's`, so `Tony` will arrive first even though his activation statement appears later in the script.

As promised, the print statements have been changed to use Python string formatting (lines :an:`1` and :an:`2`). The statements look complicated but the output is much nicer.

     1""" bank02: More Customers """
     2from SimPy.Simulation import *
     3
     4## Model components ------------------------
     5
     6
     7class Customer(Process):
     8    """ Customer arrives, looks around and leaves """
     9
    10    def visit(self, timeInBank):
    11        print("%7.4f %s: Here I am" % (now(), self.name))     # (1)
    12        yield hold, self, timeInBank
    13        print("%7.4f %s: I must leave" % (now(), self.name))  # (2)
    14
    15## Experiment data -------------------------
    16
    17maxTime = 400.0  # minutes                      # (3)
    18
    19## Model/Experiment ------------------------------
    20
    21initialize()
    22
    23c1 = Customer(name="Klaus")                      # (4)
    24activate(c1, c1.visit(timeInBank=10.0), at=5.0)
    25c2 = Customer(name="Tony")
    26activate(c2, c2.visit(timeInBank=7.0), at=2.0)
    27c3 = Customer(name="Evelyn")
    28activate(c3, c3.visit(timeInBank=20.0), at=12.0)   # (5)
    29
    30simulate(until=maxTime)                          # (6)

The trace produced by the program is shown below. Again the simulation finishes before the `400.0` specified in the `simulate` call as it has run out of events.

    1 2.0000 Tony: Here I am
    2 5.0000 Klaus: Here I am
    3 9.0000 Tony: I must leave
    412.0000 Evelyn: Here I am
    515.0000 Klaus: I must leave
    632.0000 Evelyn: I must leave

### Many Customers

Another change will allow us to have more customers. As it is tedious to give a specially chosen name to each one, we will call them `Customer00, Customer01,...` and use a separate `Source` class to create and activate them. To make things clearer we do not use the random numbers in this model.

The following listing shows the new program. Lines :an:`1` to :an:`4` define a `Source` class. Its PEM, here called `generate`, is defined in lines :an:`2` to :an:`4`. This PEM has a couple of arguments: the `number` of customers to be generated and the Time Between Arrivals, `TBA`. It consists of a loop that creates a sequence of numbered `Customers` from `0` to `(number-1)`, inclusive. We create a customer and give it a name in line :an:`3`. It is then activated at the current simulation time (the final argument of the `activate` statement is missing so that the default value of `now()` is used as the time). We also specify how long the customer is to stay in the bank. To keep it simple, all customers stay exactly `12` minutes. After each new customer is activated, the `Source` holds for a fixed time (`yield hold,self,TBA`) before creating the next one (line :an:`4`).

A `Source`, `s`, is created in line :an:`5` and activated at line :an:`6` where the number of customers to be generated is set to `maxNumber = 5` and the interval between customers to `ARRint = 10.0`. Once started at time `0.0` it creates customers at intervals and each customer then operates independently of the others:

     1""" bank03: Many non-random Customers """
     2from SimPy.Simulation import *
     3
     4## Model components ------------------------
     5
     6
     7class Source(Process):                               # (1)
     8    """ Source generates customers regularly """
     9
    10    def generate(self, number, TBA):                 # (2)
    11        for i in range(number):
    12            c = Customer(name="Customer%02d" % (i))  # (3)
    13            activate(c, c.visit(timeInBank=12.0))
    14            yield hold, self, TBA                    # (4)
    15
    16
    17class Customer(Process):
    18    """ Customer arrives, looks around and leaves """
    19
    20    def visit(self, timeInBank):
    21        print("%7.4f %s: Here I am" % (now(), self.name))
    22        yield hold, self, timeInBank
    23        print("%7.4f %s: I must leave" % (now(), self.name))
    24
    25## Experiment data -------------------------
    26
    27maxNumber = 5
    28maxTime = 400.0  # minutes
    29ARRint = 10.0    # time between arrivals, minutes
    30
    31## Model/Experiment ------------------------------
    32
    33initialize()
    34s = Source()                                         # (5)
    35activate(s, s.generate(number=maxNumber,             # (6)
    36                      TBA=ARRint), at=0.0)
    37simulate(until=maxTime)

The output is:

     1 0.0000 Customer00: Here I am
     210.0000 Customer01: Here I am
     312.0000 Customer00: I must leave
     420.0000 Customer02: Here I am
     522.0000 Customer01: I must leave
     630.0000 Customer03: Here I am
     732.0000 Customer02: I must leave
     840.0000 Customer04: Here I am
     942.0000 Customer03: I must leave
    1052.0000 Customer04: I must leave

### Many Random Customers

We now extend this model to allow arrivals at random. In simulation this is usually interpreted as meaning that the times between customer arrivals are distributed as exponential random variates. There is little change in our program, we use a `Source` object, as before.

The exponential random variate is generated in line :an:`1` with `meanTBA` as the mean Time Between Arrivals and used in line :an:`2`. Note that this parameter is not exactly intuitive. As already mentioned, the Python `expovariate` method uses the rate of arrivals as the parameter not the average interval between them. The exponential delay between two arrivals gives pseudo-random arrivals. In this model the first customer arrives at time `0.0`.

The `seed` method is called to initialize the random number stream in the `model` routine (line :an:`3`). It is possible to leave this call out but if we wish to do serious comparisons of systems, we must have control over the random variates and therefore control over the seeds. Then we can run identical models with different seeds or different models with identical seeds. We provide the seeds as control parameters of the run. Here a seed is assigned in line :an:`3` but it is clear it could have been read in or manually entered on an input form.

     1""" bank06: Many Random Customers """
     2from SimPy.Simulation import *
     3from random import expovariate, seed
     4
     5## Model components ------------------------
     6
     7
     8class Source(Process):
     9    """ Source generates customers at random """
    10
    11    def generate(self, number, meanTBA):
    12        for i in range(number):
    13            c = Customer(name="Customer%02d" % (i))
    14            activate(c, c.visit(timeInBank=12.0))
    15            t = expovariate(1.0 / meanTBA)                # (1)
    16            yield hold, self, t                         # (2)
    17
    18
    19class Customer(Process):
    20    """ Customer arrives, looks around and leaves """
    21
    22    def visit(self, timeInBank=0):
    23        print("%7.4f %s: Here I am" % (now(), self.name))
    24        yield hold, self, timeInBank
    25        print("%7.4f %s: I must leave" % (now(), self.name))
    26
    27## Experiment data -------------------------
    28
    29maxNumber = 5
    30maxTime = 400.0  # minutes
    31ARRint = 10.0    # mean arrival interval, minutes
    32
    33## Model/Experiment ------------------------------
    34
    35seed(99999)                                             # (3)
    36initialize()
    37s = Source(name='Source')
    38activate(s, s.generate(number=maxNumber,
    39                      meanTBA=ARRint), at=0.0)
    40simulate(until=maxTime)

with the following output:

     1 0.0000 Customer00: Here I am
     2 1.2839 Customer01: Here I am
     3 4.9842 Customer02: Here I am
     412.0000 Customer00: I must leave
     513.2839 Customer01: I must leave
     616.9842 Customer02: I must leave
     735.5432 Customer03: Here I am
     847.5432 Customer03: I must leave
     948.9918 Customer04: Here I am
    1060.9918 Customer04: I must leave

## A Service counter

So far, the model has been more like an art gallery, the customers entering, looking around, and leaving. Now they are going to require service from the bank clerk. We extend the model to include a service counter which will be modelled as an object of SimPy’s `Resource` class with a single resource unit. The actions of a `Resource` are simple: a customer `requests` a unit of the resource (a clerk). If one is free he gets service (and removes the unit). If there is no free clerk the customer joins the queue (managed by the resource object) until it is their turn to be served. As each customer completes service and `releases` the unit, the clerk can start serving the next in line.

### One Service counter

The service counter is created as a `Resource` (`k`) in line :an:`8`. This is provided as an argument to the `Source` (line :an:`9`) which, in turn, provides it to each customer it creates and activates (line :an:`1`).

The actions involving the service counter, `k`, in the customer’s PEM are:

- the `yield request` statement in line :an:`3`. If the server is free then the customer can start service immediately and the code moves on to line :an:`4`. If the server is busy, the customer is automatically queued by the Resource. When it eventually comes available the PEM moves on to line :an:`4`.

- the `yield hold` statement in line :an:`5` where the operation of the service counter is modelled. Here the service time is a fixed `timeInBank`. During this period the customer is being served.

- the `yield release` statement in line :an:`6`. The current customer completes service and the service counter becomes available for any remaining customers in the queue.

Observe that the service counter is used with the pattern (`yield request..`; `yield hold..`; `yield release..`).

To show the effect of the service counter on the activities of the customers, I have added line :an:`2` to record when the customer arrived and line :an:`4` to record the time between arrival in the bank and starting service. Line :an:`4` is after the `yield request` command and will be reached only when the request is satisfied. It is before the `yield hold` that corresponds to the start of service. The variable `wait` will record how long the customer waited and will be 0 if he received service at once. This technique of saving the arrival time in a variable is common. So the `print` statement also prints out how long the customer waited in the bank before starting service.

     1""" bank07: One Counter,random arrivals """
     2from SimPy.Simulation import *
     3from random import expovariate, seed
     4
     5## Model components ------------------------
     6
     7
     8class Source(Process):
     9    """ Source generates customers randomly """
    10
    11    def generate(self, number, meanTBA, resource):
    12        for i in range(number):
    13            c = Customer(name="Customer%02d" % (i))
    14            activate(c, c.visit(timeInBank=12.0,
    15                                 res=resource))       # (1)
    16            t = expovariate(1.0 / meanTBA)
    17            yield hold, self, t
    18
    19
    20class Customer(Process):
    21    """ Customer arrives, is served and  leaves """
    22
    23    def visit(self, timeInBank, res):
    24        arrive = now()                                # (2)  arrival time
    25        print("%8.3f %s: Here I am" % (now(), self.name))
    26
    27        yield request, self, res                      # (3)
    28        wait = now() - arrive                         # (4)  waiting time
    29        print("%8.3f %s: Waited %6.3f" % (now(), self.name, wait))
    30        yield hold, self, timeInBank                  # (5)
    31        yield release, self, res                      # (6)
    32
    33        print("%8.3f %s: Finished" % (now(), self.name))
    34
    35## Experiment data -------------------------
    36
    37maxNumber = 5                                         # (7)
    38maxTime = 400.0   # minutes
    39ARRint = 10.0     # mean, minutes
    40k = Resource(name="Counter", unitName="Clerk")        # (8)
    41
    42## Model/Experiment ------------------------------
    43seed(99999)
    44initialize()
    45s = Source('Source')
    46activate(s, s.generate(number=maxNumber,
    47                      meanTBA=ARRint, resource=k), at=0.0)  # (9)
    48simulate(until=maxTime)

Examining the trace we see that the first, and last, customers get instant service but the others have to wait. We still only have five customers (line :an:`4`) so we cannot draw general conclusions.

     1   0.000 Customer00: Here I am
     2   0.000 Customer00: Waited  0.000
     3   1.284 Customer01: Here I am
     4   4.984 Customer02: Here I am
     5  12.000 Customer00: Finished
     6  12.000 Customer01: Waited 10.716
     7  24.000 Customer01: Finished
     8  24.000 Customer02: Waited 19.016
     9  35.543 Customer03: Here I am
    10  36.000 Customer02: Finished
    11  36.000 Customer03: Waited  0.457
    12  48.000 Customer03: Finished
    13  48.992 Customer04: Here I am
    14  48.992 Customer04: Waited  0.000
    15  60.992 Customer04: Finished

### A server with a random service time

This is a simple change to the model in that we retain the single service counter but make the customer service time a random variable. As is traditional in the study of simple queues we first assume an exponential service time and set the mean to `timeInBank`.

The service time random variable, `tib`, is generated in line :an:`1` and used in line :an:`2`. The argument to be used in the call of `expovariate` is not the mean of the distribution, `timeInBank`, but is the rate `1/timeInBank`.

We have also collected together a number of constants by defining a number of appropriate variables and giving them values. These are in lines :an:`3` to :an:`4`.

     1""" bank08: A counter with a random service time """
     2from SimPy.Simulation import *
     3from random import expovariate, seed
     4
     5## Model components ------------------------
     6
     7
     8class Source(Process):
     9    """ Source generates customers randomly """
    10
    11    def generate(self, number, meanTBA, resource):
    12        for i in range(number):
    13            c = Customer(name="Customer%02d" % (i,))
    14            activate(c, c.visit(b=resource))
    15            t = expovariate(1.0 / meanTBA)
    16            yield hold, self, t
    17
    18
    19class Customer(Process):
    20    """ Customer arrives, is served and leaves """
    21
    22    def visit(self, b):
    23        arrive = now()
    24        print("%8.4f %s: Here I am     " % (now(), self.name))
    25        yield request, self, b
    26        wait = now() - arrive
    27        print("%8.4f %s: Waited %6.3f" % (now(), self.name, wait))
    28        tib = expovariate(1.0 / timeInBank)              # (1)
    29        yield hold, self, tib                          # (2)
    30        yield release, self, b
    31        print("%8.4f %s: Finished      " % (now(), self.name))
    32
    33## Experiment data -------------------------
    34
    35maxNumber = 5                          # (3)
    36maxTime = 400.0    # minutes
    37timeInBank = 12.0  # mean, minutes
    38ARRint = 10.0      # mean, minutes
    39theseed = 99999                         # (4)
    40
    41## Model/Experiment ------------------------------
    42
    43seed(theseed)
    44k = Resource(name="Counter", unitName="Clerk")
    45
    46initialize()
    47s = Source('Source')
    48activate(s, s.generate(number=maxNumber, meanTBA=ARRint,
    49                        resource=k), at=0.0)
    50simulate(until=maxTime)

And the output:

     1  0.0000 Customer00: Here I am
     2  0.0000 Customer00: Waited  0.000
     3  1.2839 Customer01: Here I am
     4  4.4403 Customer00: Finished
     5  4.4403 Customer01: Waited  3.156
     6 20.5786 Customer01: Finished
     7 31.8430 Customer02: Here I am
     8 31.8430 Customer02: Waited  0.000
     9 34.5594 Customer02: Finished
    10 36.2308 Customer03: Here I am
    11 36.2308 Customer03: Waited  0.000
    12 41.4313 Customer04: Here I am
    13 67.1315 Customer03: Finished
    14 67.1315 Customer04: Waited 25.700
    15 87.9241 Customer04: Finished

This model with random arrivals and exponential service times is an example of an M/M/1 queue and could rather easily be solved analytically to calculate the steady-state mean waiting time and other operating characteristics. (But not so easily solved for its transient behavior.)

## Several Service Counters

When we introduce several counters we must decide on a queue discipline. Are customers going to make one queue or are they going to form separate queues in front of each counter? Then there are complications - will they be allowed to switch lines (jockey)? We first consider a single queue with several counters and later consider separate isolated queues. We will not look at jockeying.

### Several Counters but a Single Queue

Here we model a bank whose customers arrive randomly and are to be served at a group of counters, taking a random time for service, where we assume that waiting customers form a single first-in first-out queue.

The only difference between this model and the single-server model is in line :an:`1`. We have provided two counters by increasing the capacity of the `counter` resource to 2. These units of the resource correspond to the two counters. Because both clerks cannot be called `Karen`, we have used a general name of `Clerk`.

     1""" bank09: Several Counters but a Single Queue """
     2from SimPy.Simulation import *
     3from random import expovariate, seed
     4
     5## Model components ------------------------
     6
     7
     8class Source(Process):
     9    """ Source generates customers randomly """
    10
    11    def generate(self, number, meanTBA, resource):
    12        for i in range(number):
    13            c = Customer(name="Customer%02d" % (i))
    14            activate(c, c.visit(b=resource))
    15            t = expovariate(1.0 / meanTBA)
    16            yield hold, self, t
    17
    18
    19class Customer(Process):
    20    """ Customer arrives, is served and leaves """
    21
    22    def visit(self, b):
    23        arrive = now()
    24        print("%8.4f %s: Here I am     " % (now(), self.name))
    25        yield request, self, b
    26        wait = now() - arrive
    27        print("%8.4f %s: Waited %6.3f" % (now(), self.name, wait))
    28        tib = expovariate(1.0 / timeInBank)
    29        yield hold, self, tib
    30        yield release, self, b
    31        print("%8.4f %s: Finished      " % (now(), self.name))
    32
    33## Experiment data -------------------------
    34
    35maxNumber = 5
    36maxTime = 400.0    # minutes
    37timeInBank = 12.0  # mean, minutes
    38ARRint = 10.0      # mean, minutes
    39theseed = 99999
    40
    41## Model/Experiment ------------------------------
    42
    43seed(theseed)
    44k = Resource(capacity=2, name="Counter", unitName="Clerk")   # (1)
    45
    46initialize()
    47s = Source('Source')
    48activate(s, s.generate(number=maxNumber, meanTBA=ARRint,
    49                         resource=k), at=0.0)
    50simulate(until=maxTime)

The waiting times in this model are very different from those for the single service counter. For example, none of the customers had to wait. But, again, we have observed too few customers to draw general conclusions.

     1  0.0000 Customer00: Here I am
     2  0.0000 Customer00: Waited  0.000
     3  1.2839 Customer01: Here I am
     4  1.2839 Customer01: Waited  0.000
     5  4.4403 Customer00: Finished
     6 17.4222 Customer01: Finished
     7 31.8430 Customer02: Here I am
     8 31.8430 Customer02: Waited  0.000
     9 34.5594 Customer02: Finished
    10 36.2308 Customer03: Here I am
    11 36.2308 Customer03: Waited  0.000
    12 41.4313 Customer04: Here I am
    13 41.4313 Customer04: Waited  0.000
    14 62.2239 Customer04: Finished
    15 67.1315 Customer03: Finished

### Several Counters with individual queues

Each counter now has its own queue. The programming is more complicated because the customer has to decide which one to join. The obvious technique is to make each counter a separate resource and it is useful to make a list of resource objects (line :an:`7`).

In practice, a customer will join the shortest queue. So we define a Python function, `NoInSystem(R)` (lines :an:`1` to :an:`2`) to return the sum of the number waiting and the number being served for a particular counter, `R`. This function is used in line :an:`3` to list the numbers at each counter. It is then easy to find which counter the arriving customer should join. We have also modified the trace printout, line :an:`4` to display the state of the system when the customer arrives. We choose the shortest queue in lines :an:`5` to :an:`6` (using the variable `choice`).

The rest of the program is the same as before.

     1""" bank10: Several Counters with individual queues"""
     2from SimPy.Simulation import *
     3from random import expovariate, seed
     4
     5## Model components ------------------------
     6
     7
     8class Source(Process):
     9    """ Source generates customers randomly"""
    10
    11    def generate(self, number, interval, counters):
    12        for i in range(number):
    13            c = Customer(name="Customer%02d" % (i))
    14            activate(c, c.visit(counters))
    15            t = expovariate(1.0 / interval)
    16            yield hold, self, t
    17
    18
    19def NoInSystem(R):                                      # (1)
    20    """ Total number of customers in the resource R"""
    21    return (len(R.waitQ) + len(R.activeQ))              # (2)
    22
    23
    24class Customer(Process):
    25    """ Customer arrives, chooses the shortest queue
    26        is served and leaves
    27    """
    28
    29    def visit(self, counters):
    30        arrive = now()
    31        Qlength = [NoInSystem(counters[i]) for i in range(Nc)]   # (3)
    32        print("%7.4f %s: Here I am. %s" % (now(), self.name, Qlength))  # (4)
    33        for i in range(Nc):                                      # (5)
    34            if Qlength[i] == 0 or Qlength[i] == min(Qlength):
    35                choice = i    # the index of the shortest line
    36                break                                            # (6)
    37
    38        yield request, self, counters[choice]
    39        wait = now() - arrive
    40        print("%7.4f %s: Waited %6.3f" % (now(), self.name, wait))
    41        tib = expovariate(1.0 / timeInBank)
    42        yield hold, self, tib
    43        yield release, self, counters[choice]
    44
    45        print("%7.4f %s: Finished" % (now(), self.name))
    46
    47## Experiment data -------------------------
    48
    49maxNumber = 5
    50maxTime = 400.0    # minutes
    51timeInBank = 12.0  # mean, minutes
    52ARRint = 10.0   # mean, minutes
    53Nc = 2          # number of counters
    54theseed = 787878
    55
    56## Model/Experiment ------------------------------
    57
    58seed(theseed)
    59kk = [Resource(name="Clerk0"), Resource(name="Clerk1")]          # (7)
    60initialize()
    61s = Source('Source')
    62activate(s, s.generate(number=maxNumber, interval=ARRint,
    63                      counters=kk), at=0.0)
    64simulate(until=maxTime)

The results show how the customers choose the counter with the smallest number. Unlucky `Customer03` who joins the wrong queue has to wait until `Customer01` finishes before his service can be started. There are, however, too few arrivals in these runs, limited as they are to five customers, to draw any general conclusions about the relative efficiencies of the two systems.

     1 0.0000 Customer00: Here I am. [0, 0]
     2 0.0000 Customer00: Waited  0.000
     3 9.7519 Customer00: Finished
     412.0829 Customer01: Here I am. [0, 0]
     512.0829 Customer01: Waited  0.000
     625.9167 Customer02: Here I am. [1, 0]
     725.9167 Customer02: Waited  0.000
     838.2349 Customer03: Here I am. [1, 1]
     940.4032 Customer04: Here I am. [2, 1]
    1043.0677 Customer02: Finished
    1143.0677 Customer04: Waited  2.664
    1244.0242 Customer01: Finished
    1344.0242 Customer03: Waited  5.789
    1460.1271 Customer03: Finished
    1570.2500 Customer04: Finished

## Monitors and Gathering Statistics

The traces of output that have been displayed so far are valuable for checking that the simulation is operating correctly but would become too much if we simulate a whole day. We do need to get results from our simulation to answer the original questions. What, then, is the best way to summarize the results?

One way is to analyze the traces elsewhere, piping the trace output, or a modified version of it, into a real statistical program such as R for statistical analysis, or into a file for later examination by a spreadsheet. We do not have space to examine this thoroughly here. Another way of presenting the results is to provide graphical output.

SimPy offers an easy way to gather a few simple statistics such as averages: the `Monitor` and `Tally` classes. The `Monitor` records the values of chosen variables as time series (but see the comments in Final Remarks).

### The Bank with a Monitor

We now demonstrate a `Monitor` that records the average waiting times for our customers. We return to the system with random arrivals, random service times and a single queue and remove the old trace statements. In practice, we would make the printouts controlled by a variable, say, `TRACE` which is set in the experimental data (or read in as a program option - but that is a different story). This would aid in debugging and would not complicate the data analysis. We will run the simulations for many more arrivals.

A Monitor, `wM`, is created in line :an:`2`. It `observes` and records the waiting time mentioned in line :an:`1`. We run `maxNumber=50` customers (in the call of `generate` in line :an:`3`) and have increased `maxTime` to `1000` minutes. Brief statistics are given by the Monitor methods `count()` and `mean()` in line :an:`4`.

     1""" bank11: The bank with a Monitor"""
     2from SimPy.Simulation import *
     3from random import expovariate, seed
     4
     5## Model components ------------------------
     6
     7
     8class Source(Process):
     9    """ Source generates customers randomly"""
    10
    11    def generate(self, number, interval, resource):
    12        for i in range(number):
    13            c = Customer(name="Customer%02d" % (i))
    14            activate(c, c.visit(b=resource))
    15            t = expovariate(1.0 / interval)
    16            yield hold, self, t
    17
    18
    19class Customer(Process):
    20    """ Customer arrives, is served and leaves """
    21
    22    def visit(self, b):
    23        arrive = now()
    24        yield request, self, b
    25        wait = now() - arrive
    26        wM.observe(wait)                    # (1)
    27        tib = expovariate(1.0 / timeInBank)
    28        yield hold, self, tib
    29        yield release, self, b
    30
    31## Experiment data -------------------------
    32
    33maxNumber = 50
    34maxTime = 1000.0    # minutes
    35timeInBank = 12.0   # mean, minutes
    36ARRint = 10.0    # mean, minutes
    37Nc = 2           # number of counters
    38theseed = 99999
    39
    40## Model/Experiment   ----------------------
    41
    42seed(theseed)
    43k = Resource(capacity=Nc, name="Clerk")
    44wM = Monitor()                              # (2)
    45initialize()
    46s = Source('Source')
    47activate(s, s.generate(number=maxNumber, interval=ARRint,
    48                      resource=k), at=0.0)  # (3)
    49simulate(until=maxTime)
    50
    51## Result  ----------------------------------
    52
    53result = wM.count(), wM.mean()              # (4)
    54print("Average wait for %3d completions was %5.3f minutes." % result)

The average waiting time for 50 customers in this 2-counter system is more reliable (i.e., less subject to random simulation effects) than the times we measured before but it is still not sufficiently reliable for real-world decisions. We should also replicate the runs using different random number seeds. The result of this run (using Python 3.2) is:

    Average wait for  50 completions was 8.941 minutes.

Result for Python 2.x is given in Appendix A.

### Multiple runs

To get a number of independent measurements we must replicate the runs using different random number seeds. Each replication must be independent of previous ones so the Monitor and Resources must be redefined for each run. We can no longer allow them to be global objects as we have before.

We will define a function, `model` with a parameter `runSeed` so that the random number seed can be different for different runs (lines :an:`2` to :an:`5`). The contents of the function are the same as the `Model/Experiment` section in the previous program except for one vital change.

This is required since the Monitor, `wM`, is defined inside the `model` function (line :an:`3`). A customer can no longer refer to it. In the spirit of quality computer programming we will pass `wM` as a function argument. Unfortunately we have to do this in two steps, first to the `Source` (line :an:`4`) and then from the `Source` to the `Customer` (line :an:`1`).

`model()` is run for four different random-number seeds to get a set of replications (lines :an:`6` to :an:`7`).

     1""" bank12: Multiple runs of the bank with a Monitor"""
     2from SimPy.Simulation import *
     3from random import expovariate, seed
     4
     5## Model components ------------------------
     6
     7
     8class Source(Process):
     9    """ Source generates customers randomly"""
    10
    11    def generate(self, number, interval, resource, mon):
    12        for i in range(number):
    13            c = Customer(name="Customer%02d" % (i))
    14            activate(c, c.visit(b=resource, M=mon))       # (1)
    15            t = expovariate(1.0 / interval)
    16            yield hold, self, t
    17
    18
    19class Customer(Process):
    20    """ Customer arrives, is served and leaves """
    21
    22    def visit(self, b, M):
    23        arrive = now()
    24        yield request, self, b
    25        wait = now() - arrive
    26        M.observe(wait)
    27        tib = expovariate(1.0 / timeInBank)
    28        yield hold, self, tib
    29        yield release, self, b
    30
    31## Experiment data -------------------------
    32
    33maxNumber = 50
    34maxTime = 2000.0  # minutes
    35timeInBank = 12.0   # mean, minutes
    36ARRint = 10.0     # mean, minutes
    37Nc = 2            # number of counters
    38theSeed = 393939
    39
    40## Model  ----------------------------------
    41
    42
    43def model(runSeed=theSeed):                       # (2)
    44    seed(runSeed)
    45    k = Resource(capacity=Nc, name="Clerk")
    46    wM = Monitor()                                # (3)
    47
    48    initialize()
    49    s = Source('Source')
    50    activate(s, s.generate(number=maxNumber, interval=ARRint,
    51                          resource=k, mon=wM), at=0.0)  # (4)
    52    simulate(until=maxTime)
    53    return (wM.count(), wM.mean())                 # (5)
    54
    55## Experiment/Result  ----------------------------------
    56
    57theseeds = [393939, 31555999, 777999555, 319999771]  # (6)
    58for Sd in theseeds:
    59    result = model(Sd)
    60    print("Average wait for %3d completions was %6.2f minutes." % result)  # (7)

The results show some variation. Remember, though, that the system is still only operating for 50 customers so the system may not be in steady-state.

    1Average wait for  50 completions was   3.66 minutes.
    2Average wait for  50 completions was   2.62 minutes.
    3Average wait for  50 completions was   8.97 minutes.
    4Average wait for  50 completions was   5.34 minutes.

## Final Remarks

This introduction is too long and the examples are getting longer. There is much more to say about simulation with SimPy but no space. I finish with a list of topics for further study:

- GUI input. Graphical input of simulation parameters could be an advantage in some cases. SimPy allows this and programs using these facilities have been developed (see, for example, program `MM1.py` in the examples in the SimPy distribution)

- Graphical Output. Similarly, graphical output of results can also be of value, not least in debugging simulation programs and checking for steady-state conditions. SimPlot is useful here.

- Statistical Output. The `Monitor` class is useful in presenting results but more powerful methods of analysis are often needed. One solution is to output a trace and read that into a large-scale statistical system such as R.

- Priorities and Reneging in queues. SimPy allows processes to request units of resources under a priority queue discipline (preemptive or not). It also allows processes to renege from a queue.

- Other forms of Resource Facilities. SimPy has two other resource structures: `Levels` to hold bulk commodities, and `Stores` to contain an inventory of different object types.

- Advanced synchronization/scheduling commands. SimPy allows process synchronization by events and signals.

## Acknowledgements

I thank Klaus Muller, Bob Helmbold, Mukhlis Matti and other developers and users of SimPy for improving this document by sending their comments. I would be grateful for further suggestions or corrections. Please send them to: vignaux at users.sourceforge.net.

## References

- Python website: http://www.Python.org

- SimPy website: http://sourceforge.net/projects/simpy

## Appendix A

With Python 3 the definition of expovariate changed. In some cases this was back ported to some distributions of Python 2.7. Because of this the output for the bank programs varies. This section just contains the older output.

A Customer arriving at a fixed time

    5.0 Klaus  Here I am
    15.0 Klaus  I must leave

A Customer arriving at random

    10.580923 Klaus Here I am
    20.580923 Klaus I must leave

More Customers

    1 2.0000 Tony: Here I am
    2 5.0000 Klaus: Here I am
    3 9.0000 Tony: I must leave
    412.0000 Evelyn: Here I am
    515.0000 Klaus: I must leave
    632.0000 Evelyn: I must leave

Many Customers

     1 0.0000 Customer00: Here I am
     210.0000 Customer01: Here I am
     312.0000 Customer00: I must leave
     420.0000 Customer02: Here I am
     522.0000 Customer01: I must leave
     630.0000 Customer03: Here I am
     732.0000 Customer02: I must leave
     840.0000 Customer04: Here I am
     942.0000 Customer03: I must leave
    1052.0000 Customer04: I must leave

Many Random Customers

     1 0.0000 Customer00: Here I am
     212.0000 Customer00: I must leave
     321.1618 Customer01: Here I am
     432.8968 Customer02: Here I am
     533.1618 Customer01: I must leave
     633.3790 Customer03: Here I am
     736.3979 Customer04: Here I am
     844.8968 Customer02: I must leave
     945.3790 Customer03: I must leave
    1048.3979 Customer04: I must leave

One Service Counter

     1   0.000 Customer00: Here I am
     2   0.000 Customer00: Waited  0.000
     3  12.000 Customer00: Finished
     4  21.162 Customer01: Here I am
     5  21.162 Customer01: Waited  0.000
     6  32.897 Customer02: Here I am
     7  33.162 Customer01: Finished
     8  33.162 Customer02: Waited  0.265
     9  33.379 Customer03: Here I am
    10  36.398 Customer04: Here I am
    11  45.162 Customer02: Finished
    12  45.162 Customer03: Waited 11.783
    13  57.162 Customer03: Finished
    14  57.162 Customer04: Waited 20.764
    15  69.162 Customer04: Finished

A server with a random service time

     1  0.0000 Customer00: Here I am
     2  0.0000 Customer00: Waited  0.000
     3 14.0819 Customer00: Finished
     4 21.1618 Customer01: Here I am
     5 21.1618 Customer01: Waited  0.000
     6 21.6441 Customer02: Here I am
     7 24.7845 Customer01: Finished
     8 24.7845 Customer02: Waited  3.140
     9 31.9954 Customer03: Here I am
    10 41.0215 Customer04: Here I am
    11 43.9441 Customer02: Finished
    12 43.9441 Customer03: Waited 11.949
    13 49.9552 Customer03: Finished
    14 49.9552 Customer04: Waited  8.934
    15 52.2900 Customer04: Finished

Several Counters but a Single Queue

     1  0.0000 Customer00: Here I am
     2  0.0000 Customer00: Waited  0.000
     3 14.0819 Customer00: Finished
     4 21.1618 Customer01: Here I am
     5 21.1618 Customer01: Waited  0.000
     6 21.6441 Customer02: Here I am
     7 21.6441 Customer02: Waited  0.000
     8 24.7845 Customer01: Finished
     9 31.9954 Customer03: Here I am
    10 31.9954 Customer03: Waited  0.000
    11 32.9459 Customer03: Finished
    12 40.8037 Customer02: Finished
    13 41.0215 Customer04: Here I am
    14 41.0215 Customer04: Waited  0.000
    15 43.3562 Customer04: Finished

Several Counters with individual queues

     1 0.0000 Customer00: Here I am. [0, 0]
     2 0.0000 Customer00: Waited  0.000
     3 3.5483 Customer01: Here I am. [1, 0]
     4 3.5483 Customer01: Waited  0.000
     5 4.4169 Customer01: Finished
     6 6.4349 Customer02: Here I am. [1, 0]
     7 6.4349 Customer02: Waited  0.000
     8 7.0368 Customer00: Finished
     9 9.7200 Customer02: Finished
    10 9.8846 Customer03: Here I am. [0, 0]
    11 9.8846 Customer03: Waited  0.000
    1219.8340 Customer03: Finished
    1326.2357 Customer04: Here I am. [0, 0]
    1426.2357 Customer04: Waited  0.000
    1529.8709 Customer04: Finished

The Bank with a Monitor

    Average wait for  50 completions was 3.430 minutes.

Multiple runs

    1Average wait for  50 completions was   2.75 minutes.
    2Average wait for  50 completions was   6.01 minutes.
    3Average wait for  50 completions was   5.53 minutes.
    4Average wait for  50 completions was   3.76 minutes.