README

   1 SymPy
   2 =====
   3
   4 A Python library for symbolic mathematics.
   5
   6 http://code.google.com/p/sympy/
   7
   8 All people who contributed to SymPy by sending at least a patch or more (in
   9 the order of the date of their first contribution):
  10     Ondrej Certik <ondrej@certik.cz>
  11     Fabian Seoane <fabian@fseoane.net>
  12     Jurjen N.E. Bos <jnebos@gmail.com>
  13     Mateusz Paprocki <mattpap@gmail.com>
  14     Marc-Etienne M.Leveille <protonyc@gmail.com>
  15     Brian Jorgensen <brian.jorgensen@gmail.com>
  16     Jason Gedge <inferno1386@gmail.com>
  17     Robert Schwarz <lethargo@googlemail.com>
  18     Pearu Peterson <pearu.peterson@gmail.com>
  19     Fredrik Johansson <fredrik.johansson@gmail.com>
  20     Chris Wu <chris.wu@gmail.com>
  21     Kirill Smelkov <kirr@landau.phys.spbu.ru>
  22     Ulrich Hecht <ulrich.hecht@gmail.com>
  23     Goutham Lakshminarayan <dl.goutham@gmail.com>
  24
  25 And many more people helped on the mailinglist, reported bugs etc.
  26
  27 License: New BSD License (see the LICENSE file for details)
  28 covers all files in the sympy repository unless stated otherwise.
  29
  30 0. Download
  31 -----------
  32
  33 svn checkout http://sympy.googlecode.com/svn/trunk/ sympy
  34
  35 For other options (tarballs, debs, etc.), see the web page of SymPy.
  36
  37
  38 1. Documentation and usage
  39 --------------------------
  40
  41 Everything is at:
  42
  43 http://code.google.com/p/sympy/wiki/Documentation
  44
  45 If you don't want to read that, here is a short usage:
  46
  47 From this directory, start python and:
  48 >>> from sympy import Symbol, cos
  49 >>> x=Symbol('x')
  50 >>> e=1/cos(x)
  51 >>> print e.series(x,10)
  52 1 + (1/2)*x**2 + (5/24)*x**4 + (61/720)*x**6 + (277/8064)*x**8 + O(x**10)
  53
  54 SymPy also comes with a console that is a simple wrapper around the
  55 classic python console (or ipython when available) that loads the
  56 sympy namespace and defines three symbols: x, y, z.
  57
  58 To start it issue:
  59
  60   ./bin/isympy
  61
  62 from this directory if SymPy is not installed or simply
  63
  64   isympy
  65
  66 if SymPy is installed somewhere in your PATH.
  67
  68
  69 3. Tests
  70 --------
  71
  72 to execute tests, run
  73
  74 ./setup.py test
  75
  76 in the current directory.  You need to have py.test installed.
  77
  78
  79 4. How to install py.test
  80 -------------------------
  81
  82 If you use Debian, just install the python-codespeak-lib. Otherwise:
  83
  84 Execute in your home directory:
  85
  86 svn co http://codespeak.net/svn/py/dist py-dist
  87
  88 This will create a "py-dist" directory in you home dir. Add this line to
  89 your .bashrc:
  90
  91 eval `python ~/py-dist/py/env.py`
  92
  93 Now you can call "py.test" from anywhere.
  94
  95 5. Clean
  96 --------
  97
  98 To clean everything (thus getting the same tree as in the svn):
  99
 100 ./setup.py clean
 101
 102
 103 6. Brief History
 104 ----------------
 105
 106 SymPy was started by Ondrej Certik in 2005, he wrote some code during the
 107 summer, then he wrote some more code during the summer 2006. In February 2007,
 108 Fabian Seoane joined the project and helped fixed many things, contributed
 109 documentation and made it alive again. 5 students improved SymPy incredibly
 110 during the summer 2007 as part of the Google Summer of Code. Pearu Peterson
 111 joined the development during the summer 2007 and he has made SymPy much more
 112 competitive by rewriting the core from scratch, that has made it from 10x to
 113 100x faster.