|
| 1 | +# SymPy |
| 2 | + |
| 3 | +[](https://pypi.python.org/pypi/sympy) |
| 4 | +[](https://travis-ci.org/sympy/sympy) |
| 5 | +[](https://gitter.im/sympy/sympy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 6 | +[](https://zenodo.org/badge/latestdoi/18918/sympy/sympy) |
| 7 | +[](https://codecov.io/gh/sympy/sympy) |
| 8 | + |
| 9 | +A Python library for symbolic mathematics. |
| 10 | + |
| 11 | +<https://sympy.org/> |
| 12 | + |
| 13 | +See the AUTHORS file for the list of authors. |
| 14 | + |
| 15 | +And many more people helped on the SymPy mailing list, reported bugs, |
| 16 | +helped organize SymPy's participation in the Google Summer of Code, the |
| 17 | +Google Highly Open Participation Contest, Google Code-In, wrote and |
| 18 | +blogged about SymPy... |
| 19 | + |
| 20 | +License: New BSD License (see the LICENSE file for details) covers all |
| 21 | +files in the sympy repository unless stated otherwise. |
| 22 | + |
| 23 | +Our mailing list is at |
| 24 | +<https://groups.google.com/forum/?fromgroups#!forum/sympy>. |
| 25 | + |
| 26 | +We have community chat at [Gitter](https://gitter.im/sympy/sympy). Feel |
| 27 | +free to ask us anything there. We have a very welcoming and helpful |
| 28 | +community. |
| 29 | + |
| 30 | +## Download |
| 31 | + |
| 32 | +The recommended installation method is through Anaconda, |
| 33 | +<https://www.anaconda.com/download/> |
| 34 | + |
| 35 | +You can also get the latest version of SymPy from |
| 36 | +<https://pypi.python.org/pypi/sympy/> |
| 37 | + |
| 38 | +To get the git version do |
| 39 | + |
| 40 | + $ git clone git://github.com/sympy/sympy.git |
| 41 | + |
| 42 | +For other options (tarballs, debs, etc.), see |
| 43 | +<https://docs.sympy.org/dev/install.html>. |
| 44 | + |
| 45 | +## Documentation and Usage |
| 46 | + |
| 47 | +For in-depth instructions on installation and building the |
| 48 | +documentation, see the [SymPy Documentation Style Guide |
| 49 | +<https://docs.sympy.org/dev/documentation-style-guide.html>. |
| 50 | + |
| 51 | +Everything is at: |
| 52 | + |
| 53 | +<https://docs.sympy.org/> |
| 54 | + |
| 55 | +You can generate everything at the above site in your local copy of |
| 56 | +SymPy by: |
| 57 | + |
| 58 | + $ cd doc |
| 59 | + $ make html |
| 60 | + |
| 61 | +Then the docs will be in <span class="title-ref">\_build/html</span>. If |
| 62 | +you don't want to read that, here is a short usage: |
| 63 | + |
| 64 | +From this directory, start Python and: |
| 65 | + |
| 66 | +``` python |
| 67 | +>>> from sympy import Symbol, cos |
| 68 | +>>> x = Symbol('x') |
| 69 | +>>> e = 1/cos(x) |
| 70 | +>>> print(e.series(x, 0, 10)) |
| 71 | +1 + x**2/2 + 5*x**4/24 + 61*x**6/720 + 277*x**8/8064 + O(x**10) |
| 72 | +``` |
| 73 | + |
| 74 | +SymPy also comes with a console that is a simple wrapper around the |
| 75 | +classic python console (or IPython when available) that loads the SymPy |
| 76 | +namespace and executes some common commands for you. |
| 77 | + |
| 78 | +To start it, issue: |
| 79 | + |
| 80 | + $ bin/isympy |
| 81 | + |
| 82 | +from this directory, if SymPy is not installed or simply: |
| 83 | + |
| 84 | + $ isympy |
| 85 | + |
| 86 | +if SymPy is installed. |
| 87 | + |
| 88 | +## Installation |
| 89 | + |
| 90 | +SymPy has a hard dependency on the [mpmath](http://mpmath.org/) library |
| 91 | +(version \>= 0.19). You should install it first, please refer to the |
| 92 | +mpmath installation guide: |
| 93 | + |
| 94 | +<https://github.com/fredrik-johansson/mpmath#1-download--installation> |
| 95 | + |
| 96 | +To install SymPy using PyPI, run the following command: |
| 97 | + |
| 98 | + $ pip install sympy |
| 99 | + |
| 100 | +To install SymPy using Anaconda, run the following command: |
| 101 | + |
| 102 | + $ conda install -c anaconda sympy |
| 103 | + |
| 104 | +To install SymPy from GitHub source, first clone SymPy using `git`: |
| 105 | + |
| 106 | + $ git clone https://github.com/sympy/sympy.git |
| 107 | + |
| 108 | +Then, in the `sympy` repository that you cloned, simply run: |
| 109 | + |
| 110 | + $ python setup.py install |
| 111 | + |
| 112 | +See <https://docs.sympy.org/dev/install.html> for more information. |
| 113 | + |
| 114 | +## Contributing |
| 115 | + |
| 116 | +We welcome contributions from anyone, even if you are new to open |
| 117 | +source. Please read our [Introduction to Contributing](https://github.com/sympy/sympy/wiki/Introduction-to-contributing) |
| 118 | +page and the [SymPy Documentation Style Guide](https://docs.sympy.org/dev/documentation-style-guide.html). If you |
| 119 | +are new and looking for some way to contribute, a good place to start is |
| 120 | +to look at the issues tagged [Easy to Fix](https://github.com/sympy/sympy/issues?q=is%3Aopen+is%3Aissue+label%3A%22Easy+to+Fix%22). |
| 121 | + |
| 122 | +Please note that all participants in this project are expected to follow |
| 123 | +our Code of Conduct. By participating in this project you agree to abide |
| 124 | +by its terms. See [CODE\_OF\_CONDUCT.md](CODE_OF_CONDUCT.md). |
| 125 | + |
| 126 | +## Tests |
| 127 | + |
| 128 | +To execute all tests, run: |
| 129 | + |
| 130 | + $./setup.py test |
| 131 | + |
| 132 | +in the current directory. |
| 133 | + |
| 134 | +For the more fine-grained running of tests or doctests, use `bin/test` |
| 135 | +or respectively `bin/doctest`. The master branch is automatically tested |
| 136 | +by Travis CI. |
| 137 | + |
| 138 | +To test pull requests, use |
| 139 | +[sympy-bot](https://github.com/sympy/sympy-bot). |
| 140 | + |
| 141 | +## Regenerate Experimental <span class="title-ref">LaTeX</span> Parser/Lexer |
| 142 | + |
| 143 | +The parser and lexer generated with the [ANTLR4](http://antlr4.org) |
| 144 | +toolchain in <span class="title-ref">sympy/parsing/latex/\_antlr</span> |
| 145 | +and checked into the repo. Presently, most users should not need to |
| 146 | +regenerate these files, but if you plan to work on this feature, you |
| 147 | +will need the <span class="title-ref">antlr4</span> command-line tool |
| 148 | +available. One way to get it is: |
| 149 | + |
| 150 | + $ conda install -c conda-forge antlr=4.7 |
| 151 | + |
| 152 | +After making changes to |
| 153 | +<span class="title-ref">sympy/parsing/latex/LaTeX.g4</span>, run: |
| 154 | + |
| 155 | + $ ./setup.py antlr |
| 156 | + |
| 157 | +## Clean |
| 158 | + |
| 159 | +To clean everything (thus getting the same tree as in the repository): |
| 160 | + |
| 161 | + $ ./setup.py clean |
| 162 | + |
| 163 | +You can also clean things with git using: |
| 164 | + |
| 165 | + $ git clean -Xdf |
| 166 | + |
| 167 | +which will clear everything ignored by `.gitignore`, and: |
| 168 | + |
| 169 | + $ git clean -df |
| 170 | + |
| 171 | +to clear all untracked files. You can revert the most recent changes in |
| 172 | +git with: |
| 173 | + |
| 174 | + $ git reset --hard |
| 175 | + |
| 176 | +WARNING: The above commands will all clear changes you may have made, |
| 177 | +and you will lose them forever. Be sure to check things with `git |
| 178 | +status`, `git diff`, `git clean -Xn` and `git clean -n` before doing any |
| 179 | +of those. |
| 180 | + |
| 181 | +## Bugs |
| 182 | + |
| 183 | +Our issue tracker is at <https://github.com/sympy/sympy/issues>. Please |
| 184 | +report any bugs that you find. Or, even better, fork the repository on |
| 185 | +GitHub and create a pull request. We welcome all changes, big or small, |
| 186 | +and we will help you make the pull request if you are new to git (just |
| 187 | +ask on our mailing list or Gitter). |
| 188 | + |
| 189 | +## Brief History |
| 190 | + |
| 191 | +SymPy was started by Ondřej Čertík in 2005, he wrote some code during |
| 192 | +the summer, then he wrote some more code during summer 2006. In February |
| 193 | +2007, Fabian Pedregosa joined the project and helped fixed many things, |
| 194 | +contributed documentation and made it alive again. 5 students (Mateusz |
| 195 | +Paprocki, Brian Jorgensen, Jason Gedge, Robert Schwarz, and Chris Wu) |
| 196 | +improved SymPy incredibly during summer 2007 as part of the Google |
| 197 | +Summer of Code. Pearu Peterson joined the development during the summer |
| 198 | +2007 and he has made SymPy much more competitive by rewriting the core |
| 199 | +from scratch, that has made it from 10x to 100x faster. Jurjen N.E. Bos |
| 200 | +has contributed pretty-printing and other patches. Fredrik Johansson has |
| 201 | +written mpmath and contributed a lot of patches. |
| 202 | + |
| 203 | +SymPy has participated in every Google Summer of Code since 2007. You |
| 204 | +can see <https://github.com/sympy/sympy/wiki#google-summer-of-code> for |
| 205 | +full details. Each year has improved SymPy by bounds. Most of SymPy's |
| 206 | +development has come from Google Summer of Code students. |
| 207 | + |
| 208 | +In 2011, Ondřej Čertík stepped down as lead developer, with Aaron |
| 209 | +Meurer, who also started as a Google Summer of Code student, taking his |
| 210 | +place. Ondřej Čertík is still active in the community but is too busy |
| 211 | +with work and family to play a lead development role. |
| 212 | + |
| 213 | +Since then, a lot more people have joined the development and some |
| 214 | +people have also left. You can see the full list in doc/src/aboutus.rst, |
| 215 | +or online at: |
| 216 | + |
| 217 | +<https://docs.sympy.org/dev/aboutus.html#sympy-development-team> |
| 218 | + |
| 219 | +The git history goes back to 2007 when development moved from svn to hg. |
| 220 | +To see the history before that point, look at |
| 221 | +<https://github.com/sympy/sympy-old>. |
| 222 | + |
| 223 | +You can use git to see the biggest developers. The command: |
| 224 | + |
| 225 | + $ git shortlog -ns |
| 226 | + |
| 227 | +will show each developer, sorted by commits to the project. The command: |
| 228 | + |
| 229 | + $ git shortlog -ns --since="1 year" |
| 230 | + |
| 231 | +will show the top developers from the last year. |
| 232 | + |
| 233 | +## Citation |
| 234 | + |
| 235 | +To cite SymPy in publications use |
| 236 | + |
| 237 | +> Meurer A, Smith CP, Paprocki M, Čertík O, Kirpichev SB, Rocklin M, |
| 238 | +> Kumar A, Ivanov S, Moore JK, Singh S, Rathnayake T, Vig S, Granger BE, |
| 239 | +> Muller RP, Bonazzi F, Gupta H, Vats S, Johansson F, Pedregosa F, Curry |
| 240 | +> MJ, Terrel AR, Roučka Š, Saboo A, Fernando I, Kulal S, Cimrman R, |
| 241 | +> Scopatz A. (2017) SymPy: symbolic computing in Python. *PeerJ Computer |
| 242 | +> Science* 3:e103 <https://doi.org/10.7717/peerj-cs.103> |
| 243 | +
|
| 244 | +A BibTeX entry for LaTeX users is |
| 245 | + |
| 246 | +``` bibtex |
| 247 | +@article{10.7717/peerj-cs.103, |
| 248 | + title = {SymPy: symbolic computing in Python}, |
| 249 | + author = {Meurer, Aaron and Smith, Christopher P. and Paprocki, Mateusz and \v{C}ert\'{i}k, Ond\v{r}ej and Kirpichev, Sergey B. and Rocklin, Matthew and Kumar, Amit and Ivanov, Sergiu and Moore, Jason K. and Singh, Sartaj and Rathnayake, Thilina and Vig, Sean and Granger, Brian E. and Muller, Richard P. and Bonazzi, Francesco and Gupta, Harsh and Vats, Shivam and Johansson, Fredrik and Pedregosa, Fabian and Curry, Matthew J. and Terrel, Andy R. and Rou\v{c}ka, \v{S}t\v{e}p\'{a}n and Saboo, Ashutosh and Fernando, Isuru and Kulal, Sumith and Cimrman, Robert and Scopatz, Anthony}, |
| 250 | + year = 2017, |
| 251 | + month = Jan, |
| 252 | + keywords = {Python, Computer algebra system, Symbolics}, |
| 253 | + abstract = { |
| 254 | + SymPy is an open-source computer algebra system written in pure Python. It is built with a focus on extensibility and ease of use, through both interactive and programmatic applications. These characteristics have led SymPy to become a popular symbolic library for the scientific Python ecosystem. This paper presents the architecture of SymPy, a description of its features, and a discussion of select submodules. The supplementary material provides additional examples and further outlines details of the architecture and features of SymPy. |
| 255 | + }, |
| 256 | + volume = 3, |
| 257 | + pages = {e103}, |
| 258 | + journal = {PeerJ Computer Science}, |
| 259 | + issn = {2376-5992}, |
| 260 | + url = {https://doi.org/10.7717/peerj-cs.103}, |
| 261 | + doi = {10.7717/peerj-cs.103} |
| 262 | +} |
| 263 | +``` |
| 264 | + |
| 265 | +SymPy is BSD licensed, so you are free to use it whatever you like, be |
| 266 | +it academic, commercial, creating forks or derivatives, as long as you |
| 267 | +copy the BSD statement if you redistribute it (see the LICENSE file for |
| 268 | +details). That said, although not required by the SymPy license, if it |
| 269 | +is convenient for you, please cite SymPy when using it in your work and |
| 270 | +also consider contributing all your changes back, so that we can |
| 271 | +incorporate it and all of us will benefit in the end. |
0 commit comments