{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathpgf.html
More file actions
415 lines (379 loc) · 38.4 KB
/
Copy pathpgf.html
File metadata and controls
415 lines (379 loc) · 38.4 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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Typesetting With XeLaTeX/LuaLaTeX — Matplotlib 3.3.2 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css?3.3.2" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.2 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="next" title="Text rendering With LaTeX" href="usetex.html" />
<link rel="prev" title="Writing mathematical expressions" href="mathtext.html" />
<link rel="top" title="Matplotlib 3.3.2 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/tutorials/text/pgf.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<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 (v3.3.2). For the latest version see <a href="https://matplotlib.org/stable/tutorials/text/pgf.html">https://matplotlib.org/stable/tutorials/text/pgf.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.2</span></div>
<img src="../../_static/logo2_compressed.svg" height="125px" 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>
<nav class="main-nav">
<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="../index.html">Tutorials</a></li>
<li><a href="../../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<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="usetex.html" title="Text rendering With LaTeX"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="mathtext.html" title="Writing mathematical expressions"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="../../users/index.html" >User's Guide</a> »</li>
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Tutorials</a> »</li>
<li class="nav-item nav-item-this"><a href="">Typesetting With XeLaTeX/LuaLaTeX</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Typesetting With XeLaTeX/LuaLaTeX</a><ul>
<li><a class="reference internal" href="#multi-page-pdf-files">Multi-Page PDF Files</a></li>
<li><a class="reference internal" href="#font-specification">Font specification</a></li>
<li><a class="reference internal" href="#custom-preamble">Custom preamble</a></li>
<li><a class="reference internal" href="#choosing-the-tex-system">Choosing the TeX system</a></li>
<li><a class="reference internal" href="#troubleshooting">Troubleshooting</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="../../users/index.html">User's Guide</a><ul>
<li><a href="../index.html">Tutorials</a><ul>
<li>Previous: <a href="mathtext.html" title="previous chapter">Writing mathematical expressions</a></li>
<li>Next: <a href="usetex.html" title="next chapter">Text rendering With LaTeX</a></li>
</ul></li>
</ul></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/tutorials/text/pgf.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="sphx-glr-download-link-note admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Click <a class="reference internal" href="#sphx-glr-download-tutorials-text-pgf-py"><span class="std std-ref">here</span></a> to download the full example code</p>
</div>
<div class="sphx-glr-example-title section" id="typesetting-with-xelatex-lualatex">
<span id="sphx-glr-tutorials-text-pgf-py"></span><h1>Typesetting With XeLaTeX/LuaLaTeX<a class="headerlink" href="#typesetting-with-xelatex-lualatex" title="Permalink to this headline">¶</a></h1>
<p>How to typeset text with the <code class="docutils literal notranslate"><span class="pre">pgf</span></code> backend in Matplotlib.</p>
<p>Using the <code class="docutils literal notranslate"><span class="pre">pgf</span></code> backend, Matplotlib can export figures as pgf drawing
commands that can be processed with pdflatex, xelatex or lualatex. XeLaTeX and
LuaLaTeX have full Unicode support and can use any font that is installed in
the operating system, making use of advanced typographic features of OpenType,
AAT and Graphite. Pgf pictures created by <code class="docutils literal notranslate"><span class="pre">plt.savefig('figure.pgf')</span></code>
can be embedded as raw commands in LaTeX documents. Figures can also be
directly compiled and saved to PDF with <code class="docutils literal notranslate"><span class="pre">plt.savefig('figure.pdf')</span></code> by
switching the backend</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">matplotlib</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="s1">'pgf'</span><span class="p">)</span>
</pre></div>
</div>
<p>or by explicitly requesting the use of the <code class="docutils literal notranslate"><span class="pre">pgf</span></code> backend</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="s1">'figure.pdf'</span><span class="p">,</span> <span class="n">backend</span><span class="o">=</span><span class="s1">'pgf'</span><span class="p">)</span>
</pre></div>
</div>
<p>or by registering it for handling pdf output</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.backends.backend_pgf</span> <span class="kn">import</span> <span class="n">FigureCanvasPgf</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backend_bases</span><span class="o">.</span><span class="n">register_backend</span><span class="p">(</span><span class="s1">'pdf'</span><span class="p">,</span> <span class="n">FigureCanvasPgf</span><span class="p">)</span>
</pre></div>
</div>
<p>The last method allows you to keep using regular interactive backends and to
save xelatex, lualatex or pdflatex compiled PDF files from the graphical user
interface.</p>
<p>Matplotlib's pgf support requires a recent <a class="reference external" href="http://www.tug.org">LaTeX</a> installation that includes
the TikZ/PGF packages (such as <a class="reference external" href="http://www.tug.org/texlive/">TeXLive</a>), preferably with XeLaTeX or LuaLaTeX
installed. If either pdftocairo or ghostscript is present on your system,
figures can optionally be saved to PNG images as well. The executables
for all applications must be located on your <span class="target" id="index-0"></span><a class="reference internal" href="../../faq/environment_variables_faq.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a>.</p>
<p><a class="reference internal" href="../../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a> that control the behavior of the pgf backend:</p>
<blockquote>
<div><table border="1" class="docutils align-default">
<colgroup>
<col width="24%" />
<col width="76%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Documentation</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>pgf.preamble</td>
<td>Lines to be included in the LaTeX preamble</td>
</tr>
<tr class="row-odd"><td>pgf.rcfonts</td>
<td>Setup fonts from rc params using the fontspec package</td>
</tr>
<tr class="row-even"><td>pgf.texsystem</td>
<td>Either "xelatex" (default), "lualatex" or "pdflatex"</td>
</tr>
</tbody>
</table>
</div></blockquote>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>TeX defines a set of special characters, such as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># $ % & ~ _ ^ \ { }</span>
</pre></div>
</div>
<p class="last">Generally, these characters must be escaped correctly. For convenience,
some characters (_, ^, %) are automatically escaped outside of math
environments.</p>
</div>
<div class="section" id="multi-page-pdf-files">
<span id="pgf-rcfonts"></span><h2>Multi-Page PDF Files<a class="headerlink" href="#multi-page-pdf-files" title="Permalink to this headline">¶</a></h2>
<p>The pgf backend also supports multipage pdf files using
<a class="reference internal" href="../../api/backend_pgf_api.html#matplotlib.backends.backend_pgf.PdfPages" title="matplotlib.backends.backend_pgf.PdfPages"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PdfPages</span></code></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.backends.backend_pgf</span> <span class="kn">import</span> <span class="n">PdfPages</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="k">with</span> <span class="n">PdfPages</span><span class="p">(</span><span class="s1">'multipage.pdf'</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="p">{</span><span class="s1">'author'</span><span class="p">:</span> <span class="s1">'Me'</span><span class="p">})</span> <span class="k">as</span> <span class="n">pdf</span><span class="p">:</span>
<span class="n">fig1</span><span class="p">,</span> <span class="n">ax1</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span>
<span class="n">ax1</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
<span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">fig1</span><span class="p">)</span>
<span class="n">fig2</span><span class="p">,</span> <span class="n">ax2</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span>
<span class="n">ax2</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
<span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">fig2</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="font-specification">
<h2>Font specification<a class="headerlink" href="#font-specification" title="Permalink to this headline">¶</a></h2>
<p>The fonts used for obtaining the size of text elements or when compiling
figures to PDF are usually defined in the <a class="reference internal" href="../../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a>. You can also use the
LaTeX default Computer Modern fonts by clearing the lists for <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=font.serif#a-sample-matplotlibrc-file"><span class="pre">rcParams["font.serif"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['DejaVu</span> <span class="pre">Serif',</span> <span class="pre">'Bitstream</span> <span class="pre">Vera</span> <span class="pre">Serif',</span> <span class="pre">'Computer</span> <span class="pre">Modern</span> <span class="pre">Roman',</span> <span class="pre">'New</span> <span class="pre">Century</span> <span class="pre">Schoolbook',</span> <span class="pre">'Century</span> <span class="pre">Schoolbook</span> <span class="pre">L',</span> <span class="pre">'Utopia',</span> <span class="pre">'ITC</span> <span class="pre">Bookman',</span> <span class="pre">'Bookman',</span> <span class="pre">'Nimbus</span> <span class="pre">Roman</span> <span class="pre">No9</span> <span class="pre">L',</span> <span class="pre">'Times</span> <span class="pre">New</span> <span class="pre">Roman',</span> <span class="pre">'Times',</span> <span class="pre">'Palatino',</span> <span class="pre">'Charter',</span> <span class="pre">'serif']</span></code>),
<code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=font.sans-serif#a-sample-matplotlibrc-file"><span class="pre">rcParams["font.sans-serif"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['DejaVu</span> <span class="pre">Sans',</span> <span class="pre">'Bitstream</span> <span class="pre">Vera</span> <span class="pre">Sans',</span> <span class="pre">'Computer</span> <span class="pre">Modern</span> <span class="pre">Sans</span> <span class="pre">Serif',</span> <span class="pre">'Lucida</span> <span class="pre">Grande',</span> <span class="pre">'Verdana',</span> <span class="pre">'Geneva',</span> <span class="pre">'Lucid',</span> <span class="pre">'Arial',</span> <span class="pre">'Helvetica',</span> <span class="pre">'Avant</span> <span class="pre">Garde',</span> <span class="pre">'sans-serif']</span></code>) or <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=font.monospace#a-sample-matplotlibrc-file"><span class="pre">rcParams["font.monospace"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['DejaVu</span> <span class="pre">Sans</span> <span class="pre">Mono',</span> <span class="pre">'Bitstream</span> <span class="pre">Vera</span> <span class="pre">Sans</span> <span class="pre">Mono',</span> <span class="pre">'Computer</span> <span class="pre">Modern</span> <span class="pre">Typewriter',</span> <span class="pre">'Andale</span> <span class="pre">Mono',</span> <span class="pre">'Nimbus</span> <span class="pre">Mono</span> <span class="pre">L',</span> <span class="pre">'Courier</span> <span class="pre">New',</span> <span class="pre">'Courier',</span> <span class="pre">'Fixed',</span> <span class="pre">'Terminal',</span> <span class="pre">'monospace']</span></code>). Please note that the glyph
coverage of these fonts is very limited. If you want to keep the Computer
Modern font face but require extended Unicode support, consider installing the
<a class="reference external" href="https://sourceforge.net/projects/cm-unicode/">Computer Modern Unicode</a> fonts <em>CMU Serif</em>, <em>CMU Sans Serif</em>, etc.</p>
<p>When saving to <code class="docutils literal notranslate"><span class="pre">.pgf</span></code>, the font configuration Matplotlib used for the
layout of the figure is included in the header of the text file.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="sd">"""</span>
<span class="sd">=========</span>
<span class="sd">Pgf Fonts</span>
<span class="sd">=========</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="o">.</span><span class="n">update</span><span class="p">({</span>
<span class="s2">"font.family"</span><span class="p">:</span> <span class="s2">"serif"</span><span class="p">,</span>
<span class="s2">"font.serif"</span><span class="p">:</span> <span class="p">[],</span> <span class="c1"># use latex default serif font</span>
<span class="s2">"font.sans-serif"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"DejaVu Sans"</span><span class="p">],</span> <span class="c1"># use a specific sans-serif font</span>
<span class="p">})</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mf">4.5</span><span class="p">,</span> <span class="mf">2.5</span><span class="p">))</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">5</span><span class="p">))</span>
<span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">3.</span><span class="p">,</span> <span class="s2">"serif"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.</span><span class="p">,</span> <span class="s2">"monospace"</span><span class="p">,</span> <span class="n">family</span><span class="o">=</span><span class="s2">"monospace"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">2.5</span><span class="p">,</span> <span class="mf">2.</span><span class="p">,</span> <span class="s2">"sans-serif"</span><span class="p">,</span> <span class="n">family</span><span class="o">=</span><span class="s2">"sans-serif"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">2.5</span><span class="p">,</span> <span class="mf">1.</span><span class="p">,</span> <span class="s2">"comic sans"</span><span class="p">,</span> <span class="n">family</span><span class="o">=</span><span class="s2">"Comic Sans MS"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="s2">"µ is not $</span><span class="se">\\</span><span class="s2">mu$"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">tight_layout</span><span class="p">(</span><span class="o">.</span><span class="mi">5</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="custom-preamble">
<span id="pgf-preamble"></span><h2>Custom preamble<a class="headerlink" href="#custom-preamble" title="Permalink to this headline">¶</a></h2>
<p>Full customization is possible by adding your own commands to the preamble.
Use <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=pgf.preamble#a-sample-matplotlibrc-file"><span class="pre">rcParams["pgf.preamble"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">''</span></code>) if you want to configure the math fonts,
using <code class="docutils literal notranslate"><span class="pre">unicode-math</span></code> for example, or for loading additional packages. Also,
if you want to do the font configuration yourself instead of using the fonts
specified in the rc parameters, make sure to disable <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=pgf.rcfonts#a-sample-matplotlibrc-file"><span class="pre">rcParams["pgf.rcfonts"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">True</span></code>).</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="sd">"""</span>
<span class="sd">============</span>
<span class="sd">Pgf Preamble</span>
<span class="sd">============</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="n">mpl</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="s2">"pgf"</span><span class="p">)</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="o">.</span><span class="n">update</span><span class="p">({</span>
<span class="s2">"font.family"</span><span class="p">:</span> <span class="s2">"serif"</span><span class="p">,</span> <span class="c1"># use serif/main font for text elements</span>
<span class="s2">"text.usetex"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="c1"># use inline math for ticks</span>
<span class="s2">"pgf.rcfonts"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="c1"># don't setup fonts from rc parameters</span>
<span class="s2">"pgf.preamble"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">([</span>
<span class="s2">"</span><span class="se">\\</span><span class="s2">usepackage</span><span class="si">{units}</span><span class="s2">"</span><span class="p">,</span> <span class="c1"># load additional packages</span>
<span class="s2">"</span><span class="se">\\</span><span class="s2">usepackage</span><span class="si">{metalogo}</span><span class="s2">"</span><span class="p">,</span>
<span class="s2">"</span><span class="se">\\</span><span class="s2">usepackage{unicode-math}"</span><span class="p">,</span> <span class="c1"># unicode math setup</span>
<span class="sa">r</span><span class="s2">"\setmathfont{xits-math.otf}"</span><span class="p">,</span>
<span class="sa">r</span><span class="s2">"\setmainfont{DejaVu Serif}"</span><span class="p">,</span> <span class="c1"># serif font via preamble</span>
<span class="p">])</span>
<span class="p">})</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mf">4.5</span><span class="p">,</span> <span class="mf">2.5</span><span class="p">))</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">5</span><span class="p">))</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="s2">"unicode text: я, ψ, €, ü, </span><span class="se">\\</span><span class="s2">unitfrac[10]{°}</span><span class="si">{µm}</span><span class="s2">"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">XeLaTeX"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">legend</span><span class="p">([</span><span class="s2">"unicode math: $λ=∑_i^∞ μ_i^2$"</span><span class="p">])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">tight_layout</span><span class="p">(</span><span class="o">.</span><span class="mi">5</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="choosing-the-tex-system">
<span id="pgf-texsystem"></span><h2>Choosing the TeX system<a class="headerlink" href="#choosing-the-tex-system" title="Permalink to this headline">¶</a></h2>
<p>The TeX system to be used by Matplotlib is chosen by <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=pgf.texsystem#a-sample-matplotlibrc-file"><span class="pre">rcParams["pgf.texsystem"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code>).
Possible values are <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code> (default), <code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code> and <code class="docutils literal notranslate"><span class="pre">'pdflatex'</span></code>.
Please note that when selecting pdflatex, the fonts and Unicode handling must
be configured in the preamble.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="sd">"""</span>
<span class="sd">=============</span>
<span class="sd">Pgf Texsystem</span>
<span class="sd">=============</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="o">.</span><span class="n">update</span><span class="p">({</span>
<span class="s2">"pgf.texsystem"</span><span class="p">:</span> <span class="s2">"pdflatex"</span><span class="p">,</span>
<span class="s2">"pgf.preamble"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">([</span>
<span class="sa">r</span><span class="s2">"\usepackage[utf8x]</span><span class="si">{inputenc}</span><span class="s2">"</span><span class="p">,</span>
<span class="sa">r</span><span class="s2">"\usepackage[T1]</span><span class="si">{fontenc}</span><span class="s2">"</span><span class="p">,</span>
<span class="sa">r</span><span class="s2">"\usepackage</span><span class="si">{cmbright}</span><span class="s2">"</span><span class="p">,</span>
<span class="p">]),</span>
<span class="p">})</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mf">4.5</span><span class="p">,</span> <span class="mf">2.5</span><span class="p">))</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">5</span><span class="p">))</span>
<span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">3.</span><span class="p">,</span> <span class="s2">"serif"</span><span class="p">,</span> <span class="n">family</span><span class="o">=</span><span class="s2">"serif"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.</span><span class="p">,</span> <span class="s2">"monospace"</span><span class="p">,</span> <span class="n">family</span><span class="o">=</span><span class="s2">"monospace"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">2.5</span><span class="p">,</span> <span class="mf">2.</span><span class="p">,</span> <span class="s2">"sans-serif"</span><span class="p">,</span> <span class="n">family</span><span class="o">=</span><span class="s2">"sans-serif"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="sa">r</span><span class="s2">"µ is not $\mu$"</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">tight_layout</span><span class="p">(</span><span class="o">.</span><span class="mi">5</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="troubleshooting">
<span id="pgf-troubleshooting"></span><h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Please note that the TeX packages found in some Linux distributions and
MiKTeX installations are dramatically outdated. Make sure to update your
package catalog and upgrade or install a recent TeX distribution.</li>
<li>On Windows, the <span class="target" id="index-1"></span><a class="reference internal" href="../../faq/environment_variables_faq.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a> environment variable may need to be modified
to include the directories containing the latex, dvipng and ghostscript
executables. See <a class="reference internal" href="../../faq/environment_variables_faq.html#environment-variables"><span class="std std-ref">Environment Variables</span></a> and
<a class="reference internal" href="../../faq/environment_variables_faq.html#setting-windows-environment-variables"><span class="std std-ref">Setting environment variables in Windows</span></a> for details.</li>
<li>A limitation on Windows causes the backend to keep file handles that have
been opened by your application open. As a result, it may not be possible
to delete the corresponding files until the application closes (see
<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/1324">#1324</a>).</li>
<li>Sometimes the font rendering in figures that are saved to png images is
very bad. This happens when the pdftocairo tool is not available and
ghostscript is used for the pdf to png conversion.</li>
<li>Make sure what you are trying to do is possible in a LaTeX document,
that your LaTeX syntax is valid and that you are using raw strings
if necessary to avoid unintended escape sequences.</li>
<li><code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=pgf.preamble#a-sample-matplotlibrc-file"><span class="pre">rcParams["pgf.preamble"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">''</span></code>) provides lots of flexibility, and lots of
ways to cause problems. When experiencing problems, try to minimalize or
disable the custom preamble.</li>
<li>Configuring an <code class="docutils literal notranslate"><span class="pre">unicode-math</span></code> environment can be a bit tricky. The
TeXLive distribution for example provides a set of math fonts which are
usually not installed system-wide. XeTeX, unlike LuaLatex, cannot find
these fonts by their name, which is why you might have to specify
<code class="docutils literal notranslate"><span class="pre">\setmathfont{xits-math.otf}</span></code> instead of <code class="docutils literal notranslate"><span class="pre">\setmathfont{XITS</span> <span class="pre">Math}</span></code> or
alternatively make the fonts available to your OS. See this
<a class="reference external" href="http://tex.stackexchange.com/questions/43642">tex.stackexchange.com question</a> for more details.</li>
<li>If the font configuration used by Matplotlib differs from the font setting
in yout LaTeX document, the alignment of text elements in imported figures
may be off. Check the header of your <code class="docutils literal notranslate"><span class="pre">.pgf</span></code> file if you are unsure about
the fonts Matplotlib used for the layout.</li>
<li>Vector images and hence <code class="docutils literal notranslate"><span class="pre">.pgf</span></code> files can become bloated if there are a lot
of objects in the graph. This can be the case for image processing or very
big scatter graphs. In an extreme case this can cause TeX to run out of
memory: "TeX capacity exceeded, sorry" You can configure latex to increase
the amount of memory available to generate the <code class="docutils literal notranslate"><span class="pre">.pdf</span></code> image as discussed on
<a class="reference external" href="http://tex.stackexchange.com/questions/7953">tex.stackexchange.com</a>.
Another way would be to "rasterize" parts of the graph causing problems
using either the <code class="docutils literal notranslate"><span class="pre">rasterized=True</span></code> keyword, or <code class="docutils literal notranslate"><span class="pre">.set_rasterized(True)</span></code> as
per <a class="reference internal" href="../../gallery/misc/rasterization_demo.html"><span class="doc">this example</span></a>.</li>
<li>If you still need help, please see <a class="reference internal" href="../../faq/troubleshooting_faq.html#reporting-problems"><span class="std std-ref">Getting help</span></a></li>
</ul>
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-tutorials-text-pgf-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<a class="reference download internal" download="" href="../../_downloads/25d67df24430864089939d66fdd6fb2d/pgf.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">pgf.py</span></code></a></div>
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<a class="reference download internal" download="" href="../../_downloads/c05cc4ea15a9dca88c942134537c17d0/pgf.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">pgf.ipynb</span></code></a></div>
</div>
<p class="sphx-glr-signature">Keywords: matplotlib code example, codex, python plot, pyplot
<a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a></p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Sep 15, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version 3.3.2.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.