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