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