# SimPy

SimPy is a process-based discrete-event simulation framework based on standard Python. Processes in SimPy are defined by Python generator functions and can, for example, be used to model active components like customers, vehicles or agents. SimPy also provides various types of shared resources to model limited capacity congestion points (like servers, checkout counters and tunnels).

Simulations can be performed “as fast as possible”, in real time (wall clock time) or by manually stepping through the events.

Though it is theoretically possible to do continuous simulations with SimPy, it has no features that help you with that. Also, SimPy is not really required for simulations with a fixed step size and where your processes don’t interact with each other or with shared resources.

The documentation contains a tutorial, several guides explaining key concepts, a number of examples and the API reference.

SimPy is released under the MIT License. Simulation model developers are encouraged to share their SimPy modeling techniques with the SimPy community. Please post a message to the SimPy mailing list.

There is an introductory talk that explains SimPy’s concepts and provides some examples: watch the video or get the slides.

## A Simple Example

One of SimPy's main goals is to be easy to use. Here is an example for a simple SimPy simulation: a clock process that prints the current simulation time at each step:

>>> import simpy
>>>
>>> def clock(env, name, tick):
...     while True:
...         print(name, env.now)
...         yield env.timeout(tick)
...
>>> env = simpy.Environment()
>>> env.process(clock(env, 'fast', 0.5))
<Process(clock) object at 0x...>
>>> env.process(clock(env, 'slow', 1))
<Process(clock) object at 0x...>
>>> env.run(until=2)
fast 0
slow 0
fast 0.5
slow 1
fast 1.0
fast 1.5


## Installation

SimPy requires Python 2.7, 3.2, PyPy 2.0 or above.

You can install SimPy easily via pip:

$pip install -U simpy  You can also download and install SimPy manually: $ cd where/you/put/simpy/
$python setup.py install  To run SimPy’s test suite on your installation, execute: $ py.test --pyargs simpy


## Getting started

If you’ve never used SimPy before, the SimPy tutorial is a good starting point for you. You can also try out some of the Examples shipped with SimPy.

## Documentation and Help

You can find a tutorial, examples, topical guides and an API reference, as well as some information about SimPy and its history in our online documentation. For more help, contact the SimPy mailing list. SimPy users are pretty helpful. You can, of course, also dig through the source code.

If you find any bugs, please post them on our issue tracker.

Enjoy simulation programming in SimPy!

## Ports and comparable libraries

Reimplementations of SimPy and libraries similar to SimPy are available in the following languages: