matplotlib.github.com/3.4.1/users/installing_source.html at main · u7228810/matplotlib.github.com · GitHub

Repository navigation

History

208 lines (185 loc) · 12.2 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

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

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

<head>

<title>Installing from source — Matplotlib 3.4.1 documentation</title>

title="Search within Matplotlib 3.4.1 documentation"

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

</head><body>

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

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

</div>

<ul>

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

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

<a href="installing.html" title="Installation"

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

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

<li class="nav-item nav-item-1"><a href="index.html" >User's Guide</a> »</li>

<li class="nav-item nav-item-2"><a href="installing.html" accesskey="U">Installation</a> »</li>

<li class="nav-item nav-item-this"><a href="">Installing from source</a></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/users/installing_source.rst.txt"

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

</div>

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

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

<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">e</span> <span class="o">.</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>

<p>If you are building your own Matplotlib wheels (or sdists) on Windows, note

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

</div>

</div>

<br />

Last updated on Mar 31, 2021.

Created using

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

Doc version v3.4.1-3-gc6d08c6a8b-dirty.

</div>

</footer>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</html>

matplotlib.github.com/3.4.1/users/installing_source.html at main · u7228810/matplotlib.github.com · GitHub

Repository navigation

Expand file tree

Breadcrumbs

installing_source.html

Latest commit

History

Breadcrumbs

installing_source.html

File metadata and controls