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