Metadata-Version: 1.0
Name: ScipySim
Version: 0.1.1
Summary: Simulation in Python.
Home-page: http://code.google.com/p/scipy-sim/
Author: Brian Thorne
Author-email: hardbyte@gmail.com
License: GPLv3
Description: ===============
        Scipy Simulator
        ===============
        
        Scipy Simulator provides a concurrent way of modelling systems in Python using
        scipy. You might find it most useful for tasks involving <embedded systems> and
        <signal processing>. A model can be created in pure Python code - see all the
        examples in the models directory. Typical usage often looks like this::
        
        #!/usr/bin/env python
        
        from scipysim.actors.signal import Ramp
        from scipysim.actors.display import Plotter
        from scipysim.actors import Channel, Model
        
        class RampPlot( Model ):
        def __init__( self ):
        super( RampPlot, self ).__init__()
        connection = Channel()
        src = Ramp( connection )
        dst = Plotter( connection )
        self.components = [src, dst]
        
        RampPlot().run()
        
        
        
        Testing Scipy Simulator
        =======================
        
        Scipy Simulator comes with a large collection of unit tests.
        Before installing the library the tests can be run with setuptools:
        
        python setup.py test
        
        The tests can also be found in the module hierarchy and run individually:
        
        python ./scipysim/actors/io/test_io.py
        
        Or as a whole suite using nosetests:
        
        nosetests
        
        A helper script called test_scipysim.py has been placed in the scipysim module
        to launch nosetests:
        
        ./scipysim/test_scipysim.py
        
        
        Installing Scipy Simulator
        ==========================
        
        You can install scipysim to your main site-packages folder with:
        
        sudo python setup.py install
        
        on linux; and:
        
        python setup.py install
        
        on windows. To install in a more sandboxed "development" environment
        substitute develop for install, eg:
        
        sudo python setup.py develop
        
        Creating Binary Installers
        ==========================
        
        Firstly to clean the obsolete .pyc or .pyo files use:
        
        python setup.py clean --all
        
        Generate a built distribution like so:
        
        python setup.py bdist
        
        On windows to make a nice pretty GUI installer:
        
        python setup.py bdist --format wininst
        
        Similarly a source distribution can be created with:
        
        python setup.py sdist
        
        Contributors
        ============
        
        This project has been started by the Electrical Engineering Department of Canterbury University by:
        
        * Brian Thorne
        
        * Allan McInnes
        
        
        Project Site
        ============
        The main development occurs on Google Code at http://scipy-sim.googlecode.com
        
        
        Contribute to scipysim
        ======================
        
        First get the source code with mercurial:
        
        hg clone https://scipy-sim.googlecode.com/hg/ scipy-sim
        
        And send us a patch by creating a new issue http://code.google.com/p/scipy-sim/issues/entry
Keywords: simulation,scipy,discrete events
Platform: UNKNOWN
