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