Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Install mathjax for offline use #714

Merged
merged 2 commits into from

3 participants

@minrk
Owner

Add simple function to IPython.external for installing mathjax to the static dir for offline use. It checks for permission, existence, etc. and allows for installing from different tags, e.g. if you want to use stable (v1.1) or master.

All you need to do to get offline mathjax is:

from IPython.external.mathjax import install_mathjax
install_mathjax()

This could be located somewhere else, or also called from a magic, but external seemed the most logical place, since it is for bundling an external library.

I also reversed the priority of offline/cdn mathjax, so offline mathjax is preferred, since it is presumably less expensive to load. Of course, this is only true in the local network case, and a notebook server that's run from a real server would probably prefer to use the cdn. This is in a separate commit, so it's easy to rollback if we want to keep the CDN priority.

minrk added some commits
@minrk minrk Add utility function for installing mathjax for offline use
from IPython.external.mathjax import install_mathjax

install_mathjax()

* add mathjax destination to gitignore
ff2b547
@minrk minrk update notebook template to prefer offline mathjax 89aca0b
@fperez
Owner

I actually was asking @ellisonbg about the same of switching priorities. On Friday for some odd reason the mathjax CDN was timing out on my firefox session (it seems to be some dd interaction with firebug, couldn't quite figure it out) and I had to do this switch locally just so I could keep working. But I'd like Brian to give us his take on it.

In terms of the other code, a couple of comments.

  • Let's keep IPython.external to be for the actual external library hosting, so that we know that IPython.external in principle can be empty if all dependencies are provided, for example, by a linux distro.

  • would it be possible/sensible to offer the option to do a user-level install (like the --local option)? So that people could install it without sudo access?

I'm not sure how much the latter is really needed, since you tend to only not have sudo on servers, which by definition need good net connectivity. This is mostly needed for laptops likely to be offline. I just want to float the thought before we finalize it and merge.

@minrk
Owner
  • Let's keep IPython.external to be for the actual external library hosting, so that we know that IPython.external in principle can be empty if all dependencies are provided, for example, by a linux distro.

I think this makes perfect sense...but then where should we move the Qt import code to, since it doesn't qualify? And where should the mathjax install go? IPython.utils? IPython.frontend.html.notebook.util?

The ssh code was also put into external, with the argument that it is really a standalone tool, that could be brought into another package (specifically pyzmq). It can be moved to IPython.utils as well

  • would it be possible/sensible to offer the option to do a user-level install (like the --local option)? So that people could install it without sudo access?

It would be possible, as I think was discussed on IRC or Skype, to add some location in IPYTHON_DIR, but it would mean adding three-level logic for loading MathJax: 1. user-installed, 2. IPython-lib installed, 3. CDN.

@fperez
Owner

It seems to me that IPython.utils is fine... I didn't realize that we had let other things slip into external. We should probably clean that up later on, though by now we'll have to be more careful and put in deprecation warnings, as someone is likely to have started using those locations.

As for the local install, we can leave that for a future pass, if you prefer. I don't have strong feelings about it.

@ellisonbg
Owner

I think external is a much better place than this. MathJax is a an external dependency that we would ship if it were not smaller. If we don't do external, then I think it should be in IPython.frontend.html.notebook.

@minrk
Owner

IPython.frontend.html.notebook.util is where I put it the first time, but I moved it to external, based on the idea that no users should ever actually import a 5-level-down module.

If we want IPython.external to be something that distributors can easily ship without, then we should change all our conditional external imports, such that the try/except is in the actual import, rather then relying on IPython.external to do the logic:

try:
    import package
except ImportError:
    from IPython.external import package

We frequently do just the external import, and let the IPython.external package perform the try/exceptfor whether to use the bundled version or not.

@ellisonbg ellisonbg merged commit 89aca0b into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Aug 21, 2011
  1. @minrk

    Add utility function for installing mathjax for offline use

    minrk authored
    from IPython.external.mathjax import install_mathjax
    
    install_mathjax()
    
    * add mathjax destination to gitignore
  2. @minrk
This page is out of date. Refresh to see the latest.
View
1  .gitignore
@@ -4,6 +4,7 @@ _build
docs/man/*.gz
docs/source/api/generated
docs/gh-pages
+IPython/frontend/html/notebook/static/mathjax
*.py[co]
build
*.egg-info
View
82 IPython/external/mathjax.py
@@ -0,0 +1,82 @@
+"""Utility function for installing MathJax javascript library into
+the notebook's 'static' directory, for offline use.
+
+Authors:
+
+* Min RK
+"""
+
+#-----------------------------------------------------------------------------
+# Copyright (C) 2008-2011 The IPython Development Team
+#
+# Distributed under the terms of the BSD License. The full license is in
+# the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+import os
+import shutil
+import urllib2
+import tempfile
+import tarfile
+
+from IPython.frontend.html import notebook as nbmod
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+def install_mathjax(tag='v1.1', replace=False):
+ """Download and install MathJax for offline use.
+
+ This will install mathjax to the 'static' dir in the IPython notebook
+ package, so it will fail if the caller does not have write access
+ to that location.
+
+ MathJax is a ~15MB download, and ~150MB installed.
+
+ Parameters
+ ----------
+
+ replace : bool [False]
+ Whether to remove and replace an existing install.
+ tag : str ['v1.1']
+ Which tag to download. Default is 'v1.1', the current stable release,
+ but alternatives include 'v1.1a' and 'master'.
+ """
+ mathjax_url = "https://github.com/mathjax/MathJax/tarball/%s"%tag
+
+ nbdir = os.path.dirname(os.path.abspath(nbmod.__file__))
+ static = os.path.join(nbdir, 'static')
+ dest = os.path.join(static, 'mathjax')
+
+ # check for existence and permissions
+ if not os.access(static, os.W_OK):
+ raise IOError("Need have write access to %s"%static)
+ if os.path.exists(dest):
+ if replace:
+ if not os.access(dest, os.W_OK):
+ raise IOError("Need have write access to %s"%dest)
+ print "removing previous MathJax install"
+ shutil.rmtree(dest)
+ else:
+ print "offline MathJax apparently already installed"
+ return
+
+ # download mathjax
+ print "Downloading mathjax source..."
+ response = urllib2.urlopen(mathjax_url)
+ print "done"
+ # use 'r|gz' stream mode, because socket file-like objects can't seek:
+ tar = tarfile.open(fileobj=response.fp, mode='r|gz')
+ topdir = tar.firstmember.path
+ print "Extracting to %s"%dest
+ tar.extractall(static)
+ # it will be mathjax-MathJax-<sha>, rename to just mathjax
+ os.rename(os.path.join(static, topdir), dest)
+
+
+__all__ = ['install_mathjax']
View
10 IPython/frontend/html/notebook/templates/notebook.html
@@ -10,12 +10,14 @@
<!-- <link rel="stylesheet" href="static/jquery/css/themes/rocket/jquery-wijmo.css" type="text/css" /> -->
<!-- <link rel="stylesheet" href="static/jquery/css/themes/smoothness/jquery-ui-1.8.14.custom.css" type="text/css" />-->
- <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML" charset="utf-8"></script>
- <!-- <script type='text/javascript' src='static/mathjax/MathJax.js?config=TeX-AMS_HTML' charset='utf-8'></script> -->
+ <!-- <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML" charset="utf-8"></script> -->
+ <script type='text/javascript' src='static/mathjax/MathJax.js?config=TeX-AMS_HTML' charset='utf-8'></script>
<script type="text/javascript">
if (typeof MathJax == 'undefined') {
- console.log("Trying to load local copy of MathJax");
- document.write(unescape("%3Cscript type='text/javascript' src='static/mathjax/MathJax.js%3Fconfig=TeX-AMS_HTML' charset='utf-8'%3E%3C/script%3E"));
+ console.log("No local MathJax, loading from CDN");
+ document.write(unescape("%3Cscript type='text/javascript' src='http://cdn.mathjax.org/mathjax/latest/MathJax.js%3Fconfig=TeX-AMS_HTML' charset='utf-8'%3E%3C/script%3E"));
+ }else{
+ console.log("Using local MathJax");
}
</script>
Something went wrong with that request. Please try again.