.. -*- restructuredtext -*-

What's new in Eventsim 0.5.6
=============================

* Fixed some bugs, optimised program
* Renamed models to discrete
* Now all classes begin with an uppercase 
* discrete(formerly models) now has its own class for easy manipulation
* Two more methods added to discrete (trimval and trimlist) to display number output in a clean way and approximate to 4d.p)

Description
------------

eventsim makes discrete event easy to simulate

Currently, it consists of three modules:
discrete, randgen and simevent

MODULES
=======

Discrete
--------

Contains a class **Calculate** that takes two lists as arguments and an optional integer value (steps) for simplifying and calculating:

* probability,
* estimated variance,
* estimated mean,
* estimated standard deviation,
* expectation value,
* discreteEmp


as well as two methods **trimval** and **trimlist** to

* displaying numbers in a clean way

Randgen
------- 

contains  a class **Generate** that takes integer numbers as arguments (from no argument to 5 arguments) with optional arguments being "r" or "s". r for reverse sorted and s for ascending order sort. It is used to generate:

* random outcome,
* a unique outcome
* times of occurrence of outcome
* probability of occurrence
* cummulative probability of occurrence

Simevent
--------

contains methods for generating and estimating events that happens in a workplace scenario. Simulating events like:

* Interarrival time
* Service time
* Arrival time
* Time when service begins
* Time when service ends
* Wait time in queue
* Time customer spends in system
* Idle time of server
* table display format you you want a more structured approach


This module currently contains three classes, **Randomsim**, **Simulate**, **Simtable**

* Randomsim which generates random values to populate the inter-arrival and service time ad then calculates the rest of the values (accepts 0 - 3 arguments)

* Simulate, a more flexible class that allows you to input your own inter-arrival time and service time as a list (takes 1-2 arguments [inter-arrival, service] time)

* Simtable contains one method, drawtable() for generating a tabled format of all the data using tkinter frames.make life easier by importing all classes from simevent

.. code::

	e.g. from eventsim.simevent import * 

or risk having to import at least three different modules by youself.Using drawtable is really simple, you only need to pass in the instance of your simulation class as first argument and Tk() as second argument and your table will be generated for you

.. code::

	e.g. a = randomsim(4,6,9)
	simtable(a, Tk()).drawtable()

help on using this package is included in the examples.
If you have an old version of eventsim, you are adviced to delete/uninstall the old one if the update isn't working well 

For more help information please see help notes in the package. Stay tuned for its `documentation <https://pythonhosted.org/eventsim>`_
	
Requirements
------------

* Any version of python
* One of tkinter ot Tkinter is needed to display generated simulation in a tabular format

Download
---------

Download using

.. code::

   pip install eventsim

   

Acknowledgements
----------------

I was inspired to write this package after my university coursework demanded using python to simulate events. I hope Modelling and Simulation students find it useful

All glory belongs to God for helping me in completing my first module.


Contact
-------

If further information or help is needed, feel free to contact me on my email at taiwo.kareem36@gmail.com
This is still in a test mode please if any errror or bugs is found, feel free to contact the developer and give details
