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
  24 And many more people helped on the mailinglist, reported bugs etc.
  25
  26 License: New BSD License (see the LICENSE file for details)
  27 covers all files in the sympy repository unless stated otherwise.
  28
  29 0. Download
  30 -----------
  31
  32 svn checkout http://sympy.googlecode.com/svn/trunk/ sympy
  33
  34
  35 1. Documentation and usage
  36 --------------------------
  37
  38 Everything is at:
  39
  40 http://code.google.com/p/sympy/wiki/Documentation
  41
  42 If you don't want to read that, here is a short usage:
  43
  44 From this directory, start python and:
  45 >>> from sympy import Symbol, cos
  46 >>> x=Symbol('x')
  47 >>> e=1/cos(x)
  48 >>> print e.series(x,10)
  49 1 + (1/2)*x**2 + (5/24)*x**4 + (61/720)*x**6 + (277/8064)*x**8 + O(x**10)
  50
  51 Sympy also comes with a console that is a simple wrapper around the
  52 classic python console (or ipython when available) that loads the
  53 sympy namespace and defines three symbols: x, y, z.
  54
  55 To start it issue:
  56
  57   ./bin/isympy
  58
  59 from this directory if SymPy is not installed or simply
  60
  61   isympy
  62
  63 if SymPy is installed somewhere in your PATH.
  64
  65
  66 3. Tests
  67 --------
  68
  69 to execute tests, run
  70
  71 ./setup.py test
  72
  73 in the current directory.  You need to have py.test installed.
  74
  75
  76 4. How to install py.test
  77 -------------------------
  78
  79 If you use Debian, just install the python-codespeak-lib. Otherwise:
  80
  81 Execute in your home directory:
  82
  83 svn co http://codespeak.net/svn/py/dist py-dist
  84
  85 This will create a "py-dist" directory in you home dir. Add this line to
  86 your .bashrc:
  87
  88 eval `python ~/py-dist/py/env.py`
  89
  90 Now you can call "py.test" from anywhere.
  91
  92 5. Clean
  93 --------
  94
  95 To clean everything (thus getting the same tree as in the svn):
  96
  97 ./setup.py clean
  98
  99
 100 6. Brief History
 101 ----------------
 102
 103 SymPy was started by Ondrej Certik in 2005, he wrote some code during the
 104 summer, then he wrote some more code during the summer 2006. In February 2007,
 105 Fabian Seoane joined the project and helped fixed many things, contributed
 106 documentation and made it alive again. 5 students improved SymPy incredibly
 107 during the summer 2007 as part of the Google Summer of Code. Pearu Peterson
 108 joined the development during the summer 2007 and he has made SymPy much more
 109 competitive by rewriting the core from scratch, that has made it from 10x to
 110 100x faster.