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