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     Nimish Telang <ntelang@gmail.com>
  35     Abderrahim Kitouni <a.kitouni@gmail.com>
  36     Pan Peng <pengpanster@gmail.com>
  37     Friedrich Hagedorn <friedrich_h@gmx.de>
  38     Elrond der Elbenfuerst <elrond+sympy.org@samba-tng.org>
  39     Rizgar Mella <rizgar.mella@gmail.com>
  40     Felix Kaiser <whatfxkr@gmail.com>
  41     Roberto Nobrega <rwnobrega@gmail.com>
  42     David Roberts <dvdr18@gmail.com>
  43     Sebastian Krämer <basti.kr@gmail.com>
  44     Vinzent Steinberg <vinzent.steinberg@gmail.com>
  45     Riccardo Gori <goriccardo@gmail.com>
  46     Case Van Horsen <casevh@gmail.com>
  47     Stepan Roucka <stepan@roucka.eu>
  48     Ali Raza Syed <arsyed@gmail.com>
  49     Stefano Maggiolo <s.maggiolo@gmail.com>
  50     Robert Cimrman <cimrman3@ntc.zcu.cz>
  51     Bastian Weber <bastian.weber@gmx-topmail.de>
  52     Sebastian Krause <sebastian.krause@gmx.de>
  53     Sebastian Kreft <skreft@gmail.com>
  54
  55 And many more people helped on the SymPy mailinglist, reported bugs, helped
  56 organize SymPy's participation in the Google Summer of Code, the Google Highly
  57 Open Participation Contest, wrote and blogged about SymPy...
  58
  59 License: New BSD License (see the LICENSE file for details)
  60 covers all files in the sympy repository unless stated otherwise.
  61
  62 0. Download
  63 -----------
  64
  65 $ hg clone http://hg.sympy.org/sympy/
  66
  67 For other options (tarballs, debs, etc.), see the web page of SymPy.
  68
  69
  70 1. Documentation and usage
  71 --------------------------
  72
  73 Everything is at:
  74
  75 http://docs.sympy.org/
  76
  77 You can generate everything at the above site in your local copy of SymPy by:
  78
  79 $ cd doc
  80 $ make html
  81 $ epiphany _build/html/index.html
  82
  83 If you don't want to read that, here is a short usage:
  84
  85 From this directory, start python and:
  86 >>> from sympy import Symbol, cos
  87 >>> x = Symbol('x')
  88 >>> e = 1/cos(x)
  89 >>> print e.series(x, 0, 10)
  90 1 + (1/2)*x**2 + (5/24)*x**4 + (61/720)*x**6 + (277/8064)*x**8 + O(x**10)
  91
  92 SymPy also comes with a console that is a simple wrapper around the
  93 classic python console (or ipython when available) that loads the
  94 sympy namespace and executes some common commands for you.
  95
  96 To start it, issue:
  97
  98 $ bin/isympy
  99
 100 from this directory if SymPy is not installed or simply
 101
 102 $ isympy
 103
 104 if SymPy is installed somewhere in your PATH.
 105
 106
 107 3. Tests
 108 --------
 109
 110 to execute tests, run
 111
 112 ./setup.py test
 113
 114 in the current directory.  You need to have py.test installed.
 115
 116
 117 4. How to install py.test
 118 -------------------------
 119
 120 If you use Debian, just install the python-codespeak-lib. Otherwise:
 121
 122 Execute in your home directory:
 123
 124 svn co http://codespeak.net/svn/py/dist py-dist
 125
 126 This will create a "py-dist" directory in you home dir. Add this line to
 127 your .bashrc:
 128
 129 eval `python ~/py-dist/py/env.py`
 130
 131 Now you can call "py.test" from anywhere.
 132
 133 5. Clean
 134 --------
 135
 136 To clean everything (thus getting the same tree as in the svn):
 137
 138 ./setup.py clean
 139
 140
 141 6. Brief History
 142 ----------------
 143
 144 SymPy was started by Ondrej Certik in 2005, he wrote some code during the
 145 summer, then he wrote some more code during the summer 2006. In February 2007,
 146 Fabian Seoane joined the project and helped fixed many things, contributed
 147 documentation and made it alive again. 5 students (Mateusz Paprocki, Brian
 148 Jorgensen, Jason Gedge, Robert Schwarz and Chris Wu) improved SymPy incredibly
 149 during the summer 2007 as part of the Google Summer of Code. Pearu Peterson
 150 joined the development during the summer 2007 and he has made SymPy much more
 151 competitive by rewriting the core from scratch, that has made it from 10x to
 152 100x faster. Jurjen N.E. Bos has contributed pretty printing and other patches.
 153 Fredrik Johansson has wrote mpmath and contributed a lot of patches. Kirill
 154 Smelkov has joined the development in autumn 2007 and has improved the overall
 155 quality of SymPy a lot and is currently one of the most active developers.
 156
 157
 158 7. Citation
 159 -----------
 160
 161 To cite SymPy in publications use::
 162
 163   SymPy Development Team (2008). SymPy: Python library for symbolic mathematics
 164   URL http://www.sympy.org.
 165
 166 A BibTeX entry for LaTeX users is::
 167
 168   @Manual{,
 169     title = {SymPy: Python library for symbolic mathematics},
 170     author = {{SymPy Development Team}},
 171     year = {2008},
 172     url = {http://www.sympy.org},
 173   }
 174
 175 SymPy is BSD licensed, so you are free to use it whatever you like, be it
 176 academic, commercial, creating forks or derivatives, as long as you copy the BSD
 177 statement if you redistribute it (see the LICENSE file for details).
 178 That said, although not required by the SymPy license, if it is convenient for
 179 you, please cite SymPy when using it in your work and also consider
 180 contributing all your changes back, so that we can incorporate it and all of us
 181 will benefit in the end.