summaryrefslogtreecommitdiff
path: root/development/ipython/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/ipython/README')
-rw-r--r--development/ipython/README18
1 files changed, 11 insertions, 7 deletions
diff --git a/development/ipython/README b/development/ipython/README
index 0739d909e5..8cd63f0ddc 100644
--- a/development/ipython/README
+++ b/development/ipython/README
@@ -1,9 +1,13 @@
-IPython is a replacement shell for Python programming. It offers:
+IPython is a replacement shell for Python programming. It offers an enhanced
+Python shell for the terminal.
-* An enhanced Python shell for the terminal
-* A Qt-based console
-* A web-based notebook for coding
-* An architecture for interactive parallel computing
+The following additional features may be enabled by installing the listed
+optional dependencies:
-matplotlib, pyzmq and tornado are all strongly-recommended dependencies.
-Without these, only IPython's default console will run.
+* parallel computing: pyzmq
+* Qt console: Pygments, pyzmq
+* nbconvert: pandoc, Pygments, Sphinx
+* notebook: Jinja2, pyzmq, tornado
+* plotting: matplotlib
+* LaTeX in notebooks: ipython-mathjax
+* documentation: matplotlib, Pygments, Sphinx (also set DOCS=yes)