{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathtroubleshooting_faq.html
More file actions
326 lines (300 loc) · 21 KB
/
Copy pathtroubleshooting_faq.html
File metadata and controls
326 lines (300 loc) · 21 KB
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Troubleshooting — Matplotlib 2.1.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.1.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.1.1 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib FAQ" href="index.html" />
<link rel="next" title="Environment Variables" href="environment_variables_faq.html" />
<link rel="prev" title="How-To" href="howto_faq.html" />
<link rel="canonical" href="https://matplotlib.org/stable/faq/troubleshooting_faq.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.1). For the latest version see <a href="https://matplotlib.org/stable/faq/troubleshooting_faq.html">https://matplotlib.org/stable/faq/troubleshooting_faq.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="environment_variables_faq.html" title="Environment Variables"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="howto_faq.html" title="How-To"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib FAQ</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Troubleshooting</a><ul>
<li><a class="reference internal" href="#obtaining-matplotlib-version">Obtaining matplotlib version</a></li>
<li><a class="reference internal" href="#matplotlib-install-location"><code class="file docutils literal"><span class="pre">matplotlib</span></code> install location</a></li>
<li><a class="reference internal" href="#matplotlib-configuration-and-cache-directory-locations"><code class="file docutils literal"><span class="pre">matplotlib</span></code> configuration and cache directory locations</a></li>
<li><a class="reference internal" href="#getting-help">Getting help</a></li>
<li><a class="reference internal" href="#problems-with-recent-git-versions">Problems with recent git versions</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib FAQ</a><ul>
<li>Previous: <a href="howto_faq.html" title="previous chapter">How-To</a></li>
<li>Next: <a href="environment_variables_faq.html" title="next chapter">Environment Variables</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/faq/troubleshooting_faq.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="troubleshooting">
<span id="troubleshooting-faq"></span><h1>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#troubleshooting" id="id1">Troubleshooting</a><ul>
<li><a class="reference internal" href="#obtaining-matplotlib-version" id="id2">Obtaining matplotlib version</a></li>
<li><a class="reference internal" href="#matplotlib-install-location" id="id3"><code class="file docutils literal"><span class="pre">matplotlib</span></code> install location</a></li>
<li><a class="reference internal" href="#matplotlib-configuration-and-cache-directory-locations" id="id4"><code class="file docutils literal"><span class="pre">matplotlib</span></code> configuration and cache directory locations</a></li>
<li><a class="reference internal" href="#getting-help" id="id5">Getting help</a></li>
<li><a class="reference internal" href="#problems-with-recent-git-versions" id="id6">Problems with recent git versions</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="obtaining-matplotlib-version">
<span id="matplotlib-version"></span><h2>Obtaining matplotlib version<a class="headerlink" href="#obtaining-matplotlib-version" title="Permalink to this headline">¶</a></h2>
<p>To find out your matplotlib version number, import it and print the
<code class="docutils literal"><span class="pre">__version__</span></code> attribute:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib</span>
<span class="gp">>>> </span><span class="n">matplotlib</span><span class="o">.</span><span class="n">__version__</span>
<span class="go">'0.98.0'</span>
</pre></div>
</div>
</div>
<div class="section" id="matplotlib-install-location">
<span id="locating-matplotlib-install"></span><h2><code class="file docutils literal"><span class="pre">matplotlib</span></code> install location<a class="headerlink" href="#matplotlib-install-location" title="Permalink to this headline">¶</a></h2>
<p>You can find what directory matplotlib is installed in by importing it
and printing the <code class="docutils literal"><span class="pre">__file__</span></code> attribute:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib</span>
<span class="gp">>>> </span><span class="n">matplotlib</span><span class="o">.</span><span class="vm">__file__</span>
<span class="go">'/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/__init__.pyc'</span>
</pre></div>
</div>
</div>
<div class="section" id="matplotlib-configuration-and-cache-directory-locations">
<span id="locating-matplotlib-config-dir"></span><h2><code class="file docutils literal"><span class="pre">matplotlib</span></code> configuration and cache directory locations<a class="headerlink" href="#matplotlib-configuration-and-cache-directory-locations" title="Permalink to this headline">¶</a></h2>
<p>Each user has a matplotlib configuration directory which may contain a
<a class="reference internal" href="../tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files"><span class="std std-ref">matplotlibrc</span></a> file. To
locate your <code class="file docutils literal"><span class="pre">matplotlib/</span></code> configuration directory, use
<code class="xref py py-func docutils literal"><span class="pre">matplotlib.get_configdir()</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="gp">>>> </span><span class="n">mpl</span><span class="o">.</span><span class="n">get_configdir</span><span class="p">()</span>
<span class="go">'/home/darren/.config/matplotlib'</span>
</pre></div>
</div>
<p>On unix-like systems, this directory is generally located in your
<span class="target" id="index-0"></span><a class="reference internal" href="environment_variables_faq.html#envvar-HOME"><code class="xref std std-envvar docutils literal"><span class="pre">HOME</span></code></a> directory under the <code class="file docutils literal"><span class="pre">.config/</span></code> directory.</p>
<p>In addition, users have a cache directory. On unix-like systems, this is
separate from the configuration directory by default. To locate your
<code class="file docutils literal"><span class="pre">.cache/</span></code> directory, use <code class="xref py py-func docutils literal"><span class="pre">matplotlib.get_cachedir()</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="gp">>>> </span><span class="n">mpl</span><span class="o">.</span><span class="n">get_cachedir</span><span class="p">()</span>
<span class="go">'/home/darren/.cache/matplotlib'</span>
</pre></div>
</div>
<p>On windows, both the config directory and the cache directory are
the same and are in your <code class="file docutils literal"><span class="pre">Documents</span> <span class="pre">and</span> <span class="pre">Settings</span></code> or <code class="file docutils literal"><span class="pre">Users</span></code>
directory by default:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="gp">>>> </span><span class="n">mpl</span><span class="o">.</span><span class="n">get_configdir</span><span class="p">()</span>
<span class="go">'C:\\Documents and Settings\\jdhunter\\.matplotlib'</span>
<span class="gp">>>> </span><span class="n">mpl</span><span class="o">.</span><span class="n">get_cachedir</span><span class="p">()</span>
<span class="go">'C:\\Documents and Settings\\jdhunter\\.matplotlib'</span>
</pre></div>
</div>
<p>If you would like to use a different configuration directory, you can
do so by specifying the location in your <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables_faq.html#envvar-MPLCONFIGDIR"><code class="xref std std-envvar docutils literal"><span class="pre">MPLCONFIGDIR</span></code></a>
environment variable – see
<a class="reference internal" href="environment_variables_faq.html#setting-linux-osx-environment-variables"><span class="std std-ref">Setting environment variables in Linux and OS-X</span></a>. Note that
<span class="target" id="index-2"></span><a class="reference internal" href="environment_variables_faq.html#envvar-MPLCONFIGDIR"><code class="xref std std-envvar docutils literal"><span class="pre">MPLCONFIGDIR</span></code></a> sets the location of both the configuration
directory and the cache directory.</p>
</div>
<div class="section" id="getting-help">
<span id="reporting-problems"></span><h2>Getting help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2>
<p>There are a number of good resources for getting help with matplotlib.
There is a good chance your question has already been asked:</p>
<ul class="simple">
<li>The <a class="reference external" href="http://matplotlib.1069221.n5.nabble.com/">mailing list archive</a>.</li>
<li><a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">Github issues</a>.</li>
<li>Stackoverflow questions tagged <a class="reference external" href="http://stackoverflow.com/questions/tagged/matplotlib">matplotlib</a>.</li>
</ul>
<p>If you are unable to find an answer to your question through search, please
provide the following information in your e-mail to the <a class="reference external" href="https://mail.python.org/mailman/listinfo/matplotlib-users">mailing list</a>:</p>
<ul>
<li><p class="first">Your operating system (Linux/UNIX users: post the output of <code class="docutils literal"><span class="pre">uname</span> <span class="pre">-a</span></code>).</p>
</li>
<li><p class="first">Matplotlib version:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"import matplotlib; print matplotlib.__version__"</span>
</pre></div>
</div>
</li>
<li><p class="first">Where you obtained Matplotlib (e.g., your Linux distribution’s packages,
Github, PyPi, or <a class="reference external" href="https://www.continuum.io/downloads">Anaconda</a> or
<a class="reference external" href="https://www.enthought.com/products/canopy/">Enthought Canopy</a>).</p>
</li>
<li><p class="first">Any customizations to your <code class="docutils literal"><span class="pre">matplotlibrc</span></code> file (see
<a class="reference internal" href="../tutorials/introductory/customizing.html#sphx-glr-tutorials-introductory-customizing-py"><span class="std std-ref">Customizing matplotlib</span></a>).</p>
</li>
<li><p class="first">If the problem is reproducible, please try to provide a <em>minimal</em>, standalone
Python script that demonstrates the problem. This is <em>the</em> critical step.
If you can’t post a piece of code that we can run and reproduce your error,
the chances of getting help are significantly diminished. Very often, the
mere act of trying to minimize your code to the smallest bit that produces
the error will help you find a bug in <em>your</em> code that is causing the
problem.</p>
</li>
<li><p class="first">You can get very helpful debugging output from matlotlib by running your
script with a <code class="docutils literal"><span class="pre">verbose-helpful</span></code> or <code class="docutils literal"><span class="pre">--verbose-debug</span></code> flags and posting
the verbose output the lists:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">simple_plot</span><span class="o">.</span><span class="n">py</span> <span class="o">--</span><span class="n">verbose</span><span class="o">-</span><span class="n">helpful</span> <span class="o">></span> <span class="n">output</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
</li>
</ul>
<p>If you compiled Matplotlib yourself, please also provide:</p>
<ul>
<li><p class="first">any changes you have made to <code class="docutils literal"><span class="pre">setup.py</span></code> or <code class="docutils literal"><span class="pre">setupext.py</span></code>.</p>
</li>
<li><p class="first">the output of:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">rm</span> <span class="o">-</span><span class="n">rf</span> <span class="n">build</span>
<span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">build</span>
</pre></div>
</div>
<p>The beginning of the build output contains lots of details about your
platform that are useful for the Matplotlib developers to diagnose your
problem.</p>
</li>
<li><p class="first">your compiler version – e.g., <code class="docutils literal"><span class="pre">gcc</span> <span class="pre">--version</span></code>.</p>
</li>
</ul>
<p>Including this information in your first e-mail to the mailing list
will save a lot of time.</p>
<p>You will likely get a faster response writing to the mailing list than
filing a bug in the bug tracker. Most developers check the bug
tracker only periodically. If your problem has been determined to be
a bug and can not be quickly solved, you may be asked to file a bug in
the tracker so the issue doesn’t get lost.</p>
</div>
<div class="section" id="problems-with-recent-git-versions">
<span id="git-trouble"></span><h2>Problems with recent git versions<a class="headerlink" href="#problems-with-recent-git-versions" title="Permalink to this headline">¶</a></h2>
<p>First make sure you have a clean build and install (see <a class="reference internal" href="installing_faq.html#clean-install"><span class="std std-ref">How to completely remove Matplotlib</span></a>),
get the latest git update, install it and run a simple test script in debug
mode:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">rm</span> <span class="o">-</span><span class="n">rf</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">site</span><span class="o">-</span><span class="n">packages</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">*</span>
<span class="n">git</span> <span class="n">clean</span> <span class="o">-</span><span class="n">xdf</span>
<span class="n">git</span> <span class="n">pull</span>
<span class="n">python</span> <span class="o">-</span><span class="n">mpip</span> <span class="n">install</span> <span class="o">-</span><span class="n">v</span> <span class="o">.</span> <span class="o">></span> <span class="n">build</span><span class="o">.</span><span class="n">out</span>
<span class="n">python</span> <span class="n">examples</span><span class="o">/</span><span class="n">pylab_examples</span><span class="o">/</span><span class="n">simple_plot</span><span class="o">.</span><span class="n">py</span> <span class="o">--</span><span class="n">verbose</span><span class="o">-</span><span class="n">debug</span> <span class="o">></span> <span class="n">run</span><span class="o">.</span><span class="n">out</span>
</pre></div>
</div>
<p>and post <code class="file docutils literal"><span class="pre">build.out</span></code> and <code class="file docutils literal"><span class="pre">run.out</span></code> to the <a class="reference external" href="https://mail.python.org/mailman/listinfo/matplotlib-devel">matplotlib-devel</a>
mailing list (please do not post git problems to the <a class="reference external" href="https://mail.python.org/mailman/listinfo/matplotlib-users">users list</a>).</p>
<p>Of course, you will want to clearly describe your problem, what you
are expecting and what you are getting, but often a clean build and
install will help. See also <a class="reference internal" href="#reporting-problems"><span class="std std-ref">Getting help</span></a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2017 The Matplotlib development team.
Last updated on Dec 11, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.