matplotlib.github.com/3.3.1/faq/installing_faq.html at main · matplotlib/matplotlib.github.com

History

338 lines (317 loc) · 23 KB

Raw

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

327

328

329

330

331

332

333

334

335

336

337

338

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Installation — Matplotlib 3.3.1 documentation</title>

title="Search within Matplotlib 3.3.1 documentation"

href="../_static/opensearch.xml"/>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.1). For the latest version see <a href="https://matplotlib.org/stable/faq/installing_faq.html">https://matplotlib.org/stable/faq/installing_faq.html</a></div>

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.1</span></div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="../users/installing.html">Installation</a></li>

<li><a href="../contents.html">Documentation</a></li>

<li><a href="../gallery/index.html">Examples</a></li>

<li><a href="../tutorials/index.html">Tutorials</a></li>

<li><a href="../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="howto_faq.html" title="How-to"

accesskey="N">next</a> |</li>

<a href="index.html" title="The Matplotlib FAQ"

accesskey="P">previous</a> |</li>

<li><a href="../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">The Matplotlib FAQ</a> »</li>

<li class="nav-item nav-item-this"><a href="">Installation</a></li>

</ul>

</div>

<h3><a href="../contents.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Installation</a><ul>

<li><a class="reference internal" href="#report-a-compilation-problem">Report a compilation problem</a></li>

<li><a class="reference internal" href="#matplotlib-compiled-fine-but-nothing-shows-up-when-i-use-it">Matplotlib compiled fine, but nothing shows up when I use it</a></li>

<li><a class="reference internal" href="#how-to-completely-remove-matplotlib">How to completely remove Matplotlib</a></li>

<li><a class="reference internal" href="#linux-notes">Linux Notes</a></li>

<li><a class="reference internal" href="#osx-notes">OSX Notes</a><ul>

<li><a class="reference internal" href="#which-python-for-osx">Which python for OSX?</a></li>

<li><a class="reference internal" href="#installing-osx-binary-wheels">Installing OSX binary wheels</a></li>

<li><a class="reference internal" href="#checking-your-installation">Checking your installation</a></li>

</ul>

</li>

<li><a class="reference internal" href="#install-from-source">Install from source</a></li>

</ul>

</li>

</ul>

<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="index.html" title="previous chapter">The Matplotlib FAQ</a></li>

</ul></li>

</ul>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/faq/installing_faq.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<span id="installing-faq"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>

<p class="topic-title">Contents</p>

<li><a class="reference internal" href="#installation" id="id2">Installation</a><ul>

<li><a class="reference internal" href="#report-a-compilation-problem" id="id3">Report a compilation problem</a></li>

<li><a class="reference internal" href="#matplotlib-compiled-fine-but-nothing-shows-up-when-i-use-it" id="id4">Matplotlib compiled fine, but nothing shows up when I use it</a></li>

<li><a class="reference internal" href="#how-to-completely-remove-matplotlib" id="id5">How to completely remove Matplotlib</a></li>

<li><a class="reference internal" href="#linux-notes" id="id6">Linux Notes</a></li>

<li><a class="reference internal" href="#osx-notes" id="id7">OSX Notes</a><ul>

<li><a class="reference internal" href="#which-python-for-osx" id="id8">Which python for OSX?</a></li>

<li><a class="reference internal" href="#installing-osx-binary-wheels" id="id9">Installing OSX binary wheels</a></li>

<li><a class="reference internal" href="#checking-your-installation" id="id10">Checking your installation</a></li>

</ul>

</li>

<li><a class="reference internal" href="#install-from-source" id="id11">Install from source</a></li>

</ul>

</li>

</ul>

</div>

<h2>Report a compilation problem<a class="headerlink" href="#report-a-compilation-problem" title="Permalink to this headline">¶</a></h2>

<p>See <a class="reference internal" href="troubleshooting_faq.html#reporting-problems"><span class="std std-ref">Getting help</span></a>.</p>

</div>

<h2>Matplotlib compiled fine, but nothing shows up when I use it<a class="headerlink" href="#matplotlib-compiled-fine-but-nothing-shows-up-when-i-use-it" title="Permalink to this headline">¶</a></h2>

<p>The first thing to try is a <a class="reference internal" href="#clean-install"><span class="std std-ref">clean install</span></a> and see if

that helps. If not, the best way to test your install is by running a script,

rather than working interactively from a python shell or an integrated

development environment such as <strong class="program">IDLE</strong> which add additional

complexities. Open up a UNIX shell or a DOS command prompt and run, for

example:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"from pylab import *; set_loglevel('debug'); plot(); show()"</span>

</pre></div>

</div>

<p>This will give you additional information about which backends Matplotlib is

loading, version information, and more. At this point you might want to make

sure you understand Matplotlib's <a class="reference internal" href="../tutorials/introductory/customizing.html"><span class="doc">configuration</span></a>

process, governed by the <code class="file docutils literal notranslate"><span class="pre">matplotlibrc</span></code> configuration file which contains

instructions within and the concept of the Matplotlib backend.</p>

<p>If you are still having trouble, see <a class="reference internal" href="troubleshooting_faq.html#reporting-problems"><span class="std std-ref">Getting help</span></a>.</p>

</div>

<span id="clean-install"></span><h2>How to completely remove Matplotlib<a class="headerlink" href="#how-to-completely-remove-matplotlib" title="Permalink to this headline">¶</a></h2>

<p>Occasionally, problems with Matplotlib can be solved with a clean

installation of the package. In order to fully remove an installed Matplotlib:</p>

<li>Delete the caches from your <a class="reference internal" href="troubleshooting_faq.html#locating-matplotlib-config-dir"><span class="std std-ref">Matplotlib configuration directory</span></a>.</li>

<li>Delete any Matplotlib directories or eggs from your <a class="reference internal" href="troubleshooting_faq.html#locating-matplotlib-install"><span class="std std-ref">installation

directory</span></a>.</li>

</ol>

</div>

<h2>Linux Notes<a class="headerlink" href="#linux-notes" title="Permalink to this headline">¶</a></h2>

<p>To install Matplotlib at the system-level, we recommend that you use your

distribution's package manager. This will guarantee that Matplotlib's

dependencies will be installed as well.</p>

<p>If, for some reason, you cannot use the package manager, you may use the wheels

available on PyPI:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">mpip</span> <span class="n">install</span> <span class="n">matplotlib</span>

</pre></div>

</div>

<p>or <a class="reference internal" href="#install-from-git"><span class="std std-ref">build Matplotlib from source</span></a>.</p>

</div>

<h2>OSX Notes<a class="headerlink" href="#osx-notes" title="Permalink to this headline">¶</a></h2>

<span id="id1"></span><h3>Which python for OSX?<a class="headerlink" href="#which-python-for-osx" title="Permalink to this headline">¶</a></h3>

<p>Apple ships OSX with its own Python, in <code class="docutils literal notranslate"><span class="pre">/usr/bin/python</span></code>, and its own copy

of Matplotlib. Unfortunately, the way Apple currently installs its own copies

of NumPy, Scipy and Matplotlib means that these packages are difficult to

upgrade (see <a class="reference external" href="https://github.com/MacPython/wiki/wiki/Which-Python#system-python-and-extra-python-packages">system python packages</a>). For that reason we strongly suggest

that you install a fresh version of Python and use that as the basis for

installing libraries such as NumPy and Matplotlib. One convenient way to

install Matplotlib with other useful Python software is to use the <a class="reference external" href="https://www.anaconda.com/">Anaconda</a>

Python scientific software collection, which includes Python itself and a

wide range of libraries; if you need a library that is not available from the

collection, you can install it yourself using standard methods such as <em>pip</em>.

See the Ananconda web page for installation support.</p>

<p>Other options for a fresh Python install are the standard installer from

<a class="reference external" href="https://www.python.org/downloads/mac-osx/">python.org</a>, or installing

Python using a general OSX package management system such as <a class="reference external" href="http://brew.sh">homebrew</a> or <a class="reference external" href="https://www.macports.org">macports</a>. Power users on

OSX will likely want one of homebrew or macports on their system to install

open source software packages, but it is perfectly possible to use these

systems with another source for your Python binary, such as Anaconda

or Python.org Python.</p>

</div>

<span id="install-osx-binaries"></span><h3>Installing OSX binary wheels<a class="headerlink" href="#installing-osx-binary-wheels" title="Permalink to this headline">¶</a></h3>

<p>If you are using Python from <a class="reference external" href="https://www.python.org">https://www.python.org</a>, Homebrew, or Macports,

then you can use the standard pip installer to install Matplotlib binaries in

the form of wheels.</p>

<p>pip is installed by default with python.org and Homebrew Python, but needs to

be manually installed on Macports with</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">port</span> <span class="n">install</span> <span class="n">py36</span><span class="o">-</span><span class="n">pip</span>

</pre></div>

</div>

<p>Once pip is installed, you can install Matplotlib and all its dependencies with

from the Terminal.app command line:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">mpip</span> <span class="n">install</span> <span class="n">matplotlib</span>

</pre></div>

</div>

<p>(<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">python3.6</span> <span class="pre">...</span></code> on Macports).</p>

<p>You might also want to install IPython or the Jupyter notebook (<code class="docutils literal notranslate"><span class="pre">python3</span> <span class="pre">-mpip</span>

<span class="pre">install</span> <span class="pre">ipython</span> <span class="pre">notebook</span></code>).</p>

</div>

<h3>Checking your installation<a class="headerlink" href="#checking-your-installation" title="Permalink to this headline">¶</a></h3>

<p>The new version of Matplotlib should now be on your Python "path". Check this

at the Terminal.app command line:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">c</span> <span class="s1">'import matplotlib; print(matplotlib.__version__, matplotlib.__file__)'</span>

</pre></div>

</div>

<p>You should see something like</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">3.0</span><span class="o">.</span><span class="mi">0</span> <span class="o">/</span><span class="n">Library</span><span class="o">/</span><span class="n">Frameworks</span><span class="o">/</span><span class="n">Python</span><span class="o">.</span><span class="n">framework</span><span class="o">/</span><span class="n">Versions</span><span class="o">/</span><span class="mf">3.6</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">6</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="fm">__init__</span><span class="o">.</span><span class="n">py</span>

</pre></div>

</div>

<p>where <code class="docutils literal notranslate"><span class="pre">3.0.0</span></code> is the Matplotlib version you just installed, and the path

following depends on whether you are using Python.org Python, Homebrew or

Macports. If you see another version, or you get an error like</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Traceback</span> <span class="p">(</span><span class="n">most</span> <span class="n">recent</span> <span class="n">call</span> <span class="n">last</span><span class="p">):</span>

<span class="n">File</span> <span class="s2">"<string>"</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1</span><span class="p">,</span> <span class="ow">in</span> <span class="o"><</span><span class="n">module</span><span class="o">></span>

<span class="ne">ImportError</span><span class="p">:</span> <span class="n">No</span> <span class="n">module</span> <span class="n">named</span> <span class="n">matplotlib</span>

</pre></div>

</div>

<p>then check that the Python binary is the one you expected by running</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">which</span> <span class="n">python3</span>

</pre></div>

</div>

<p>If you get a result like <code class="docutils literal notranslate"><span class="pre">/usr/bin/python...</span></code>, then you are getting the

Python installed with OSX, which is probably not what you want. Try closing

and restarting Terminal.app before running the check again. If that doesn't fix

the problem, depending on which Python you wanted to use, consider reinstalling

Python.org Python, or check your homebrew or macports setup. Remember that

the disk image installer only works for Python.org Python, and will not get

picked up by other Pythons. If all these fail, please <a class="reference internal" href="troubleshooting_faq.html#reporting-problems"><span class="std std-ref">let us know</span></a>.</p>

</div>

<span id="install-from-git"></span><h2>Install from source<a class="headerlink" href="#install-from-source" title="Permalink to this headline">¶</a></h2>

<p>A C compiler is required. Typically, on Linux, you will need <code class="docutils literal notranslate"><span class="pre">gcc</span></code>, which

should be installed using your distribution's package manager; on macOS, you

will need <a class="reference external" href="https://guide.macports.org/chunked/installing.html#installing.xcode">xcode</a>; on Windows, you will need Visual Studio 2015 or later.</p>

<p>Clone the main source using one of:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="nd">@github</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>

</pre></div>

</div>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>

</pre></div>

</div>

<p>and build and install with:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">matplotlib</span>

<span class="n">python</span> <span class="o">-</span><span class="n">mpip</span> <span class="n">install</span> <span class="o">.</span>

</pre></div>

</div>

<p>If you want to be able to follow the development branch as it changes

just replace the last step with:</p>

</pre></div>

</div>

<p>This creates links and installs the command line script in the appropriate

places.</p>

<p>Then, if you want to update your Matplotlib at any time, just do:</p>

</pre></div>

</div>

<p>When you run <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code>, if the output shows that only Python files have

been updated, you are all set. If C files have changed, you need to run <code class="docutils literal notranslate"><span class="pre">pip</span>

<span class="pre">install</span> <span class="pre">-e</span> <span class="pre">.</span></code> again to compile them.</p>

<p>There is more information on <a class="reference internal" href="../devel/gitwash/index.html#using-git"><span class="std std-ref">using git</span></a> in the developer

docs.</p>

</div>

</div>

<br />

Last updated on Aug 14, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.

Doc version v3.3.1-2-ge49322daa.

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

installing_faq.html

Latest commit

History

installing_faq.html

File metadata and controls