Metadata-Version: 1.1
Name: simpy
Version: 3.0.2
Summary: Event discrete, process based simulation for Python.
Home-page: https://simpy.rtfd.org
Author: Ontje Lünsdorf, Stefan Scherfke
Author-email: the_com at gmx.de; stefan at sofa-rockers.org
License: MIT License
Download-URL: https://bitbucket.org/simpy/simpy/downloads
Description: SimPy
        =====
        
        SimPy is a process-based discrete-event simulation framework based on standard
        Python. Its event dispatcher is based on Python’s `generators`__ and can also
        be used for asynchronous networking or to implement multi-agent systems (with
        both, simulated and real communication).
        
        Processes in SimPy are simple Python generator functions and are 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). From version 3.1, it will also
        provide monitoring capabilities to aid in gathering statistics about resources
        and processes.
        
        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. On the other hand, SimPy is overkill
        for simulations with a fixed step size where your processes don’t interact with
        each other or with shared resources — use a simple ``while`` loop in this case.
        
        The SimPy distribution contains tutorials, in-depth documentation, and a large
        number of examples.
        
        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-Users mailing list`__.
        
        __ http://docs.python.org/3/glossary.html#term-generator
        __ http://lists.sourceforge.net/lists/listinfo/simpy-users
        
        
        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 <http://pypi.python.org/pypi/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::
        
            $ python -c "import simpy; simpy.test()"
        
        Of course, you can keep working with SimPy 2::
        
            $ pip install "simpy>=2.3,<3"
        
        
        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.
        
        __ https://simpy.readthedocs.org/en/latest/simpy_intro/index.html
        __ https://simpy.readthedocs.org/en/latest/examples/index.html
        
        
        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-Users 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`__.
        
        __ https://simpy.readthedocs.org/en/latest/simpy_intro/index.html
        __ https://simpy.readthedocs.org/en/latest/examples/index.html
        __ https://simpy.readthedocs.org/en/latest/topical_guides/index.html
        __ https://simpy.readthedocs.org/en/latest/api_reference/index.html
        __ https://simpy.readthedocs.org/en/latest/about/index.html
        __ https://simpy.readthedocs.org/
        __ mailto:simpy-users@lists.sourceforge.net
        __ https://bitbucket.org/simpy/simpy/src
        __ https://bitbucket.org/simpy/simpy/issues?status=new&status=open
        
        Enjoy simulation programming in SimPy!
        
        
        Changelog for SimPy
        ===================
        
        3.0.2 – 2013-10-24
        ------------------
        
        - [FIX] The default capacity for ``Container`` and ``FilterStore`` is now also
          ``inf``.
        
        
        3.0.1 – 2013-10-24
        ------------------
        
        - [FIX] Documentation and default parameters of ``Store`` didn't match. Its
          default capacity is now ``inf``.
        
        
        3.0 – 2013-10-11
        ----------------
        
        SimPy 3 has been completely rewritten from scratch. Our main goals were to
        simplify the API and code base as well as making SimPy more flexible and
        extensible. Some of the most important changes are:
        
        - Stronger focus on events. Processes yield event instances and are suspended
          until the event is triggered. An example for an event is a *timeout*
          (formerly known as *hold*), but even processes are now events, too (you can
          wait until a process terminates).
        
        - Events can be combined with ``&`` (and) and ``|`` (or) to create
          *condition events*.
        
        - Process can now be defined by any generator function. You don't have to
          subclass ``Process`` anymore.
        
        - No more global simulation state. Every simulation stores its state in an
          *environment* which is comparable to the old ``Simulation`` class.
        
        - Improved resource system with newly added resource types.
        
        - Removed plotting and GUI capabilities. `Pyside`__ and `matplotlib`__ are much
          better with this.
        
        - Greatly improved test suite. Its cleaner, and the tests are shorter and more
          numerous.
        
        - Completely overhauled documentation.
        
        There is a `guide for porting from SimPy 2 to SimPy 3`__. If you want to stick
        to SimPy 2 for a while, change your requirements to ``'SimPy>=2.3,<3'``.
        
        All in all, SimPy has become a framework for asynchronous programming based on
        coroutines. It brings more than ten years of experience and scientific know-how
        in the field of event-discrete simulation to the world of asynchronous
        programming and should thus be a solid foundation for everything based on an
        event loop.
        
        You can find information about older versions on the `history page`__
        
        __ http://qt-project.org/wiki/PySide
        __ http://matplotlib.org/
        __ https://simpy.readthedocs.org/en/latest/topical_guides/porting_from_simpy2.html
        __ https://simpy.readthedocs.org/en/latest/about/history.html
        
        
        Authors
        =======
        
        SimPy was originally created by Klaus G. Müller and Tony Vignaux in 2002.
        
        In 2008, Ontje Lünsdorf and Stefan Scherfke started to contribute to SimPy and
        became active maintainers in 2011.
        
        In 2011, Karen Turner came on board to generally help with all the bits and
        pieces that may get forgotten :-)
        
        We’d also like to thank:
        
        - Johannes Koomer for a fix for Store._put.
        - Steven Kennedy for a lot of documentation and example fixes
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering
