1isympy(1) isympy(1)
2
6 isympy - interactive shell for SymPy
7
9 isympy [-c | --console] [-p ENCODING | --pretty ENCODING] [-t TYPE |
10 --types TYPE] [-o ORDER | --order ORDER] [-q | --quiet] [-d |
11 --doctest] [-C | --no-cache] [-a | --auto] [-D | --debug] [ -- |
12 PYTHONOPTIONS]
13 isympy [ {-h | --help} | {-v | --version} ]
14
16 isympy is a Python shell for SymPy. It is just a normal python shell
17 (ipython shell if you have the ipython package installed) that executes
18 the following commands so that you don't have to:
19 >>> from __future__ import division
21 >>> from sympy import *
22 >>> x, y, z = symbols("x,y,z")
23 >>> k, m, n = symbols("k,m,n", integer=True)
24 So starting isympy is equivalent to starting python (or ipython) and
27 executing the above commands by hand. It is intended for easy and quick
28 experimentation with SymPy. For more complicated programs, it is recom‐
29 mended to write a script and import things explicitly (using the "from
30 sympy import sin, log, Symbol, ..." idiom).
31
33 -c SHELL, --console=SHELL
34 Use the specified shell (python or ipython) as console backend
35 instead of the default one (ipython if present or python other‐
36 wise).
37 Example: isympy -c python
39 SHELL could be either 'ipython' or 'python'
41 -p ENCODING, --pretty=ENCODING
43 Setup pretty printing in SymPy. By default, the most pretty,
44 unicode printing is enabled (if the terminal supports it). You
45 can use less pretty ASCII printing instead or no pretty printing
46 at all.
47 Example: isympy -p no
49 ENCODING must be one of 'unicode', 'ascii' or 'no'.
51 -t TYPE, --types=TYPE
53 Setup the ground types for the polys. By default, gmpy ground
54 types are used if gmpy2 or gmpy is installed, otherwise it falls
55 back to python ground types, which are a little bit slower. You
56 can manually choose python ground types even if gmpy is in‐
57 stalled (e.g., for testing purposes).
58 Note that sympy ground types are not supported, and should be
60 used only for experimental purposes.
61 Note that the gmpy1 ground type is primarily intended for test‐
63 ing; it the use of gmpy even if gmpy2 is available.
64 This is the same as setting the environment variable
66 SYMPY_GROUND_TYPES to the given ground type (e.g.,
67 SYMPY_GROUND_TYPES='gmpy')
68 The ground types can be determined interactively from the vari‐
70 able sympy.polys.domains.GROUND_TYPES inside the isympy shell
71 itself.
72 Example: isympy -t python
74 TYPE must be one of 'gmpy', 'gmpy1' or 'python'.
76 -o ORDER, --order=ORDER
78 Setup the ordering of terms for printing. The default is lex,
79 which orders terms lexicographically (e.g., x**2 + x + 1). You
80 can choose other orderings, such as rev-lex, which will use re‐
81 verse lexicographic ordering (e.g., 1 + x + x**2).
82 Note that for very large expressions, ORDER='none' may speed up
84 printing considerably, with the tradeoff that the order of the
85 terms in the printed expression will have no canonical order
86 Example: isympy -o rev-lax
88 ORDER must be one of 'lex', 'rev-lex', 'grlex', 'rev-grlex',
90 'grevlex', 'rev-grevlex', 'old', or 'none'.
91 -q, --quiet
93 Print only Python's and SymPy's versions to stdout at startup,
94 and nothing else.
95 -d, --doctest
97 Use the same format that should be used for doctests. This is
98 equivalent to 'isympy -c python -p no'.
99 -C, --no-cache
101 Disable the caching mechanism. Disabling the cache may slow cer‐
102 tain operations down considerably. This is useful for testing
103 the cache, or for benchmarking, as the cache can result in de‐
104 ceptive benchmark timings.
105 This is the same as setting the environment variable
107 SYMPY_USE_CACHE to 'no'.
108 -a, --auto
110 Automatically create missing symbols. Normally, typing a name of
111 a Symbol that has not been instantiated first would raise
112 NameError, but with this option enabled, any undefined name will
113 be automatically created as a Symbol. This only works in IPython
114 0.11.
115 Note that this is intended only for interactive, calculator
117 style usage. In a script that uses SymPy, Symbols should be in‐
118 stantiated at the top, so that it's clear what they are.
119 This will not override any names that are already defined, which
121 includes the single character letters represented by the mnemon‐
122 ic QCOSINE (see the "Gotchas and Pitfalls" document in the docu‐
123 mentation). You can delete existing names by executing "del
124 name" in the shell itself. You can see if a name is defined by
125 typing "'name' in globals()".
126 The Symbols that are created using this have default assump‐
128 tions. If you want to place assumptions on symbols, you should
129 create them using symbols() or var().
130 Finally, this only works in the top level namespace. So, for ex‐
132 ample, if you define a function in isympy with an undefined Sym‐
133 bol, it will not work.
134 -D, --debug
136 Enable debugging output. This is the same as setting the envi‐
137 ronment variable SYMPY_DEBUG to 'True'. The debug status is set
138 in the variable SYMPY_DEBUG within isympy.
139 -- PYTHONOPTIONS
141 These options will be passed on to ipython [4m(1) shell. Only sup‐
142 ported when ipython is being used (standard python shell not
143 supported).
144 Two dashes (--) are required to separate PYTHONOPTIONS from the
146 other isympy options.
147 For example, to run iSymPy without startup banner and colors:
149 isympy -q -c ipython -- --colors=NoColor
151 -h, --help
153 Print help output and exit.
154 -v, --version
156 Print isympy version information and exit.
157
159 ${HOME}/.sympy-history
160 Saves the history of commands when using the python shell as
161 backend.
162
164 The upstreams BTS can be found at ⟨https://github.com/sympy/sympy/is‐
165 sues⟩ Please report all bugs that you find in there, this will help im‐
166 prove the overall quality of SymPy.
167
169 ipython(1), python(1)
170 2007-10-8 isympy(1)