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