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     David Lawrence <dmlawrence@gmail.com>
  25     Jaroslaw Tworek <dev.jrx@gmail.com>
  26     David Marek <h4wk.cz@gmail.com>
  27     Bernhard R. Link <brlink@debian.org>
  28
  29 And many more people helped on the SymPy mailinglist, reported bugs, helped
  30 organize SymPy's participation in the Google Summer of Code, the Google Highly
  31 Open Participation Contest, wrote and blogged about SymPy...
  32
  33 License: New BSD License (see the LICENSE file for details)
  34 covers all files in the sympy repository unless stated otherwise.
  35
  36 0. Download
  37 -----------
  38
  39 $ hg clone http://hg.sympy.org/sympy/
  40
  41 For other options (tarballs, debs, etc.), see the web page of SymPy.
  42
  43
  44 1. Documentation and usage
  45 --------------------------
  46
  47 Everything is at:
  48
  49 http://code.google.com/p/sympy/wiki/Documentation
  50
  51 If you don't want to read that, here is a short usage:
  52
  53 From this directory, start python and:
  54 >>> from sympy import Symbol, cos
  55 >>> x=Symbol('x')
  56 >>> e=1/cos(x)
  57 >>> print e.series(x,10)
  58 1 + (1/2)*x**2 + (5/24)*x**4 + (61/720)*x**6 + (277/8064)*x**8 + O(x**10)
  59
  60 SymPy also comes with a console that is a simple wrapper around the
  61 classic python console (or ipython when available) that loads the
  62 sympy namespace and executes some common commands for you.
  63
  64 To start it, issue:
  65
  66   ./bin/isympy
  67
  68 from this directory if SymPy is not installed or simply
  69
  70   isympy
  71
  72 if SymPy is installed somewhere in your PATH.
  73
  74
  75 3. Tests
  76 --------
  77
  78 to execute tests, run
  79
  80 ./setup.py test
  81
  82 in the current directory.  You need to have py.test installed.
  83
  84
  85 4. How to install py.test
  86 -------------------------
  87
  88 If you use Debian, just install the python-codespeak-lib. Otherwise:
  89
  90 Execute in your home directory:
  91
  92 svn co http://codespeak.net/svn/py/dist py-dist
  93
  94 This will create a "py-dist" directory in you home dir. Add this line to
  95 your .bashrc:
  96
  97 eval `python ~/py-dist/py/env.py`
  98
  99 Now you can call "py.test" from anywhere.
 100
 101 5. Clean
 102 --------
 103
 104 To clean everything (thus getting the same tree as in the svn):
 105
 106 ./setup.py clean
 107
 108
 109 6. Brief History
 110 ----------------
 111
 112 SymPy was started by Ondrej Certik in 2005, he wrote some code during the
 113 summer, then he wrote some more code during the summer 2006. In February 2007,
 114 Fabian Seoane joined the project and helped fixed many things, contributed
 115 documentation and made it alive again. 5 students (Mateusz Paprocki, Brian
 116 Jorgensen, Jason Gedge, Robert Schwarz and Chris Wu) improved SymPy incredibly
 117 during the summer 2007 as part of the Google Summer of Code. Pearu Peterson
 118 joined the development during the summer 2007 and he has made SymPy much more
 119 competitive by rewriting the core from scratch, that has made it from 10x to
 120 100x faster. Jurjen N.E. Bos has contributed pretty printing and other patches.
 121 Fredrik Johansson has wrote mpmath and contributed a lot of patches. Kirill
 122 Smelkov has joined the development in autumn 2007 and has improved the overall
 123 quality of SymPy a lot and is currently one of the most active developers.