File: INSTALLATION.rst

package info (click to toggle)
python-simpy 2.3.1%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,864 kB
  • sloc: python: 11,171; makefile: 143
file content (64 lines) | stat: -rw-r--r-- 2,265 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
============
Installation
============

This file describes the installation of SimPy |release|.

#. Check that you have Python 2.3 or above. Python 3 is not yet supported, but
   we are working on it. If necessary, download Python from http://python.org
   and install it.

#. You can install SimPy easily via `PIP <http://pypi.python.org/pypi/pip>`_
   (or ``easy_install``)::

    $ pip install SimPy
    $ # or:
    $ easy_install SimPy

   If SimPy is already installed, use the *-U* option for pip/easy_install to
   upgrade::

    $ pip install -U SimPy

   Remember, on Linux/MacOS/Unix you may need *root* privileges to install
   SimPy. This also applies to the installing SimPy manually as described
   below.

#. To manually install a SimPy tarball, or to execute the examples, download
   and unpack the SimPy archive into a folder (using option "Use folder names"
   in WinZip, "Re-create folders" in Linux Archive Manager, or similar option
   in your unpacker). This will create a SimPy-|release| folder with all source
   code and documentation.

   Open a terminal, *cd* to the SimPy folder and execute *setup.py* or
   *easy_install .* or *pip install .*::

    $ cd where/you/put/simpy/SimPy-x.y
    $ python setup.py install
    $ # or
    $ easy_install .
    $ # or
    $ pip install .

   If you do not have permissions to perform the installation as root, you can
   install SimPy into a non-standard folder::

    $ cd where/you/put/simpy/SimPy-x.y
    $ python setup.py install --home <dir>

#. Run one or more of the programs under *docs/examples* to see
   whether Python finds the SimPy module. If you get an error message
   like *ImportError: No module named SimPy*, move the SimPy folder
   into a directory which you know to be on the Python module search
   path (like /Lib/site-packages).

#. The tutorial and manuals are in the *docs/html* folder. Many users have
   commented that the Bank tutorials are valuable in getting users started on
   building their own simple models. Even a few lines of Python and SimPy can
   model significant real systems.

For more help, contact the `SimPy-Users mailing list
<mailto:simpy-users@lists.sourceforge.net>`_. SimPy users are pretty helpful.


Enjoy simulation programming in SimPy!