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