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