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