matplotlib.github.com/3.4.0/users/installing.html at plausible · matplotlib/matplotlib.github.com · GitHub

History

293 lines (271 loc) · 18.7 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

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

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

<head>

<title>Installation Guide — Matplotlib 3.4.0 documentation</title>

title="Search within Matplotlib 3.4.0 documentation"

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

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.0). For the latest version see <a href="https://matplotlib.org/stable/users/installing.html">https://matplotlib.org/stable/users/installing.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.4.0</span></div>

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

</div>

<ul>

<li><a href="#">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="../tutorials/index.html" title="Tutorials"

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

<a href="index.html" title="User's Guide"

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">User's Guide</a> »</li>

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

</ul>

</div>

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

<ul>

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

<li><a class="reference internal" href="#installing-an-official-release">Installing an official release</a></li>

<li><a class="reference internal" href="#third-party-distributions-of-matplotlib">Third-party distributions of Matplotlib</a><ul>

<li><a class="reference internal" href="#scientific-python-distributions">Scientific Python Distributions</a></li>

<li><a class="reference internal" href="#linux-using-your-package-manager">Linux: using your package manager</a></li>

</ul>

</li>

<li><a class="reference internal" href="#installing-from-source">Installing from source</a><ul>

<li><a class="reference internal" href="#building-on-windows">Building on Windows</a></li>

</ul>

</li>

</ul>

</li>

</ul>

<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/users/installing.rst.txt"

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

</div>

<h1><a class="toc-backref" href="#id1">Installation Guide</a><a class="headerlink" href="#installation-guide" title="Permalink to this headline">¶</a></h1>

<p class="last">If you wish to contribute to the project, it's recommended you

<a class="reference internal" href="#install-from-source"><span class="std std-ref">install the latest development version</span></a>.</p>

</div>

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

<li><a class="reference internal" href="#installation-guide" id="id1">Installation Guide</a><ul>

<li><a class="reference internal" href="#installing-an-official-release" id="id2">Installing an official release</a></li>

<li><a class="reference internal" href="#third-party-distributions-of-matplotlib" id="id3">Third-party distributions of Matplotlib</a><ul>

<li><a class="reference internal" href="#scientific-python-distributions" id="id4">Scientific Python Distributions</a></li>

<li><a class="reference internal" href="#linux-using-your-package-manager" id="id5">Linux: using your package manager</a></li>

</ul>

</li>

<li><a class="reference internal" href="#installing-from-source" id="id6">Installing from source</a><ul>

<li><a class="reference internal" href="#building-on-windows" id="id7">Building on Windows</a></li>

</ul>

</li>

</ul>

</li>

</ul>

</div>

<h2><a class="toc-backref" href="#id2">Installing an official release</a><a class="headerlink" href="#installing-an-official-release" title="Permalink to this headline">¶</a></h2>

<p>Matplotlib and its dependencies are available as wheel packages for macOS,

Windows and Linux distributions:</p>

<span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">U</span> <span class="n">matplotlib</span>

</pre></div>

</div>

<p>If this command results in Matplotlib being compiled from source and

there's trouble with the compilation, you can add <code class="docutils literal notranslate"><span class="pre">--prefer-binary</span></code> to

select the newest version of Matplotlib for which there is a

precompiled wheel for your OS and Python.</p>

<p>The following backends work out of the box: Agg, ps, pdf, svg</p>

<p>Python is typically shipped with tk bindings which are used by

TkAgg.</p>

<p class="last">For support of other GUI frameworks, LaTeX rendering, saving

animations and a larger selection of file formats, you can

install <a class="reference internal" href="../devel/dependencies.html#optional-dependencies"><span class="std std-ref">Optional dependencies</span></a>.</p>

</div>

<p>Although not required, we suggest also installing <code class="docutils literal notranslate"><span class="pre">IPython</span></code> for

interactive use. To easily install a complete Scientific Python

stack, see <a class="reference internal" href="#install-scipy-dists"><span class="std std-ref">Scientific Python Distributions</span></a> below.</p>

</div>

<h2><a class="toc-backref" href="#id3">Third-party distributions of Matplotlib</a><a class="headerlink" href="#third-party-distributions-of-matplotlib" title="Permalink to this headline">¶</a></h2>

<span id="install-scipy-dists"></span><h3><a class="toc-backref" href="#id4">Scientific Python Distributions</a><a class="headerlink" href="#scientific-python-distributions" title="Permalink to this headline">¶</a></h3>

<p><a class="reference external" href="https://www.anaconda.com/">Anaconda</a> and <a class="reference external" href="https://www.activestate.com/activepython/downloads">ActiveState</a> are excellent

choices that "just work" out of the box for Windows, macOS and common

Linux platforms. <a class="reference external" href="https://winpython.github.io/">WinPython</a> is an

option for Windows users. All of these distributions include

Matplotlib and <em>lots</em> of other useful (data) science tools.</p>

</div>

<h3><a class="toc-backref" href="#id5">Linux: using your package manager</a><a class="headerlink" href="#linux-using-your-package-manager" title="Permalink to this headline">¶</a></h3>

<p>If you are on Linux, you might prefer to use your package manager. Matplotlib

is packaged for almost every major Linux distribution.</p>

<li>Debian / Ubuntu: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt-get</span> <span class="pre">install</span> <span class="pre">python3-matplotlib</span></code></li>

<li>Fedora: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span> <span class="pre">python3-matplotlib</span></code></li>

<li>Red Hat: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">python3-matplotlib</span></code></li>

<li>Arch: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">pacman</span> <span class="pre">-S</span> <span class="pre">python-matplotlib</span></code></li>

</ul>

</div>

<span id="install-from-source"></span><h2><a class="toc-backref" href="#id6">Installing from source</a><a class="headerlink" href="#installing-from-source" title="Permalink to this headline">¶</a></h2>

<p>If you are interested in contributing to Matplotlib development,

running the latest source code, or just like to build everything

yourself, it is not difficult to build Matplotlib from source.</p>

<p>First you need to install the <a class="reference internal" href="../devel/dependencies.html#dependencies"><span class="std std-ref">Dependencies</span></a>.</p>

<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>The easiest way to get the latest development version to start contributing

is to go to the git <a class="reference external" href="https://github.com/matplotlib/matplotlib">repository</a>

and run:</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">https</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>

<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>

<p>If you're developing, it's better to do it in editable mode. The reason why

is that pytest's test discovery only works for Matplotlib

if installation is done this way. Also, editable mode allows your code changes

to be instantly propagated to your library code without reinstalling (though

you will have to restart your python process / kernel):</p>

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

</pre></div>

</div>

<p>If you're not developing, it can be installed from the source directory with

a simple (just replace the last step):</p>

</pre></div>

</div>

<p>To run the tests you will need to install some additional dependencies:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">dev</span><span class="o">-</span><span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>

</pre></div>

</div>

<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>

<p class="first admonition-title">Warning</p>

<p class="last">The following instructions in this section are for very custom

installations of Matplotlib. Proceed with caution because these instructions

may result in your build producing unexpected behavior and/or causing

local testing to fail.</p>

</div>

<p>If you would like to build from a tarball, grab the latest <em>tar.gz</em> release

file from <a class="reference external" href="https://pypi.org/project/matplotlib/">the PyPI files page</a>.</p>

<p>We provide a <a class="reference external" href="https://raw.githubusercontent.com/matplotlib/matplotlib/master/setup.cfg.template">setup.cfg</a> file which you can use to customize the build

process. For example, which default backend to use, whether some of the

optional libraries that Matplotlib ships with are installed, and so on. This

file will be particularly useful to those packaging Matplotlib.</p>

<h3><a class="toc-backref" href="#id7">Building on Windows</a><a class="headerlink" href="#building-on-windows" title="Permalink to this headline">¶</a></h3>

<p>Compiling Matplotlib (or any other extension module, for that matter) requires

Visual Studio 2015 or later.</p>

<p>If you are building your own Matplotlib wheels (or sdists), note that any DLLs

that you copy into the source tree will be packaged too.</p>

</div>

</div>

<br />

Last updated on Mar 26, 2021.

Created using

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

Doc version v3.4.0-2-gcb03754703.

</div>

</footer>

</body>

</html>

matplotlib.github.com/3.4.0/users/installing.html at plausible · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

installing.html

Latest commit

History

Breadcrumbs

installing.html

File metadata and controls