-
Notifications
You must be signed in to change notification settings - Fork 0
/
install.html
101 lines (89 loc) · 5.61 KB
/
install.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Installing mpld3 — Bringing Matplotlib to the Browser</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/mpld3.css?v=f78f1748" />
<link rel="stylesheet" href="_static/print.css" type="text/css" />
<script src="_static/documentation_options.js?v=f1e22e58"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/theme_extras.js"></script>
<link rel="icon" href="_static/favicon.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Frequently Asked Questions" href="faq.html" />
<link rel="prev" title="Quick Start Guide" href="quickstart.html" />
</head><body>
<div class="header"><h1 class="heading"><a href="index.html">
<span>Bringing Matplotlib to the Browser</span></a></h1>
<h2 class="heading"><span>Installing mpld3</span></h2>
</div>
<div class="topnav">
<p>
«  <a href="quickstart.html">Quick Start Guide</a>
  ::  
<a class="uplink" href="index.html">Contents</a>
  ::  
<a href="faq.html">Frequently Asked Questions</a>  »
</p>
</div>
<div class="content">
<section id="installing-mpld3">
<span id="id1"></span><h1>Installing mpld3<a class="headerlink" href="#installing-mpld3" title="Link to this heading">¶</a></h1>
<section id="installing-released-versions">
<h2>Installing released versions<a class="headerlink" href="#installing-released-versions" title="Link to this heading">¶</a></h2>
<p>The mpld3 project is compatible with Python 2.6-2.7 and 3.3-3.4.
To install the latest release, you can use the <a class="reference external" href="http://www.pip-installer.org/">pip installer</a> as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[~]$ pip install mpld3
</pre></div>
</div>
<p>If you’ve downloaded the tarball of the source distribution, you can type:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[~]$ python setup.py install
</pre></div>
</div>
<p>or to specify another install location, use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[~]$ python setup.py install --prefix=/path/to/location/
</pre></div>
</div>
</section>
<section id="installing-from-git">
<h2>Installing from git<a class="headerlink" href="#installing-from-git" title="Link to this heading">¶</a></h2>
<p>The mpld3 source is <a class="reference external" href="http://github.com/jakevdp/mpld3">available on GitHub</a>.
Installing from source requires one extra build step to sync the <a class="reference external" href="http://github.com/mpld3/mplexporter">mplexporter</a> submodule.
When installing from the gihub source, use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[~]$ python setup.py submodule
[~]$ python setup.py install
</pre></div>
</div>
</section>
<section id="building-javascript-sources">
<h2>Building JavaScript Sources<a class="headerlink" href="#building-javascript-sources" title="Link to this heading">¶</a></h2>
<p>A core piece of the mpld3 package are the JavaScript libraries, which are located in the package in the <code class="docutils literal notranslate"><span class="pre">mpld3/js/</span></code> directory.
The <code class="docutils literal notranslate"><span class="pre">mpld3.*.js</span></code> is automatically constructed from a number of source JavaScript files; if you modify these sources, the libraries must be re-built before mpld3 is installed. For more information, please refer to <code class="docutils literal notranslate"><span class="pre">CONTRIBUTING.md</span></code>, found in the project repository.</p>
</section>
<section id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">¶</a></h2>
<p>The mpld3 package is compatible with Python versions 2.6, 2.7, 3.3, and 3.4.
It requires <a class="reference external" href="http://matplotlib.org">matplotlib</a> version 1.3+ and <a class="reference external" href="http://jinja.pocoo.org">jinja2</a> version 2.7+.
Optionally, mpld3 can be used within the <a class="reference external" href="http://ipython.org">IPython</a> notebook, and requires IPython version 1.0+, and preferably IPython 2.0+ (see notes in the documentation of <a class="reference internal" href="modules/API.html#mpld3.enable_notebook" title="mpld3.enable_notebook"><code class="xref py py-func docutils literal notranslate"><span class="pre">mpld3.enable_notebook()</span></code></a>).</p>
</section>
</section>
</div>
<div class="bottomnav">
<p>
«  <a href="quickstart.html">Quick Start Guide</a>
  ::  
<a class="uplink" href="index.html">Contents</a>
  ::  
<a href="faq.html">Frequently Asked Questions</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2014, mpld3 developers.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>