matplotlib.github.com/3.0.0/tutorials/text/pgf.html at main · matplotlib/matplotlib.github.com

History

413 lines (374 loc) · 32.1 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

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

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

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

<head>

<title>Typesetting With XeLaTeX/LuaLaTeX — Matplotlib 3.0.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '3.0.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 3.0.0 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.0.0). 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 style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.0.0</div>

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

</div>

<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="usetex.html" title="Text rendering With LaTeX"

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

<a href="mathtext.html" title="Writing mathematical expressions"

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

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

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

<li><a href="../../users/index.html" >User's Guide</a> »</li>

<li><a href="../index.html" accesskey="U">Tutorials</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

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

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

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

Note

Click <a class="reference internal" href="#sphx-glr-download-tutorials-text-pgf-py">here</a> to download the full example code

</div>

<h1>Typesetting With XeLaTeX/LuaLaTeX<a class="headerlink" href="#typesetting-with-xelatex-lualatex" title="Permalink to this headline">¶</a></h1>

How to typeset text with the <code class="docutils literal notranslate">pgf</code> backend in Matplotlib.

Using the <code class="docutils literal notranslate">pgf</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">plt.savefig('figure.pgf')</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">plt.savefig('figure.pdf')</code> by either

switching to the backend

<div class="highlight-python notranslate"><div class="highlight"><pre>matplotlib.use('pgf')

</pre></div>

</div>

or registering it for handling pdf output

<div class="highlight-python notranslate"><div class="highlight"><pre>from matplotlib.backends.backend_pgf import FigureCanvasPgf

matplotlib.backend_bases.register_backend('pdf', FigureCanvasPgf)

</pre></div>

</div>

The second method allows you to keep using regular interactive backends and to

save xelatex, lualatex or pdflatex compiled PDF files from the graphical user interface.

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 <a class="reference internal" href="../../faq/environment_variables_faq.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate">PATH</code></a>.

Rc parameters that control the behavior of the pgf backend:

</colgroup>

<tr class="row-odd"><th class="head">Parameter</th>

<th class="head">Documentation</th>

</tr>

</thead>

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

Note

TeX defines a set of special characters, such as:

<div class="highlight-default notranslate"><div class="highlight"><pre># $ % & ~ _ ^ \ { }

</pre></div>

</div>

Generally, these characters must be escaped correctly. For convenience,

some characters (_,^,%) are automatically escaped outside of math

environments.

</div>

<h2>Multi-Page PDF Files<a class="headerlink" href="#multi-page-pdf-files" title="Permalink to this headline">¶</a></h2>

The pgf backend also supports multipage pdf files using <code class="docutils literal notranslate">PdfPages</code>

import matplotlib.pyplot as plt

with PdfPages('multipage.pdf', metadata={'author': 'Me'}) as pdf:

fig1, ax1 = plt.subplots()

ax1.plot([1, 5, 3])

pdf.savefig(fig1)

fig2, ax2 = plt.subplots()

ax2.plot([1, 5, 3])

pdf.savefig(fig2)

</pre></div>

</div>

<h2>Font specification<a class="headerlink" href="#font-specification" title="Permalink to this headline">¶</a></h2>

The fonts used for obtaining the size of text elements or when compiling

figures to PDF are usually defined in the matplotlib rc parameters. You can

also use the LaTeX default Computer Modern fonts by clearing the lists for

<code class="docutils literal notranslate">font.serif</code>, <code class="docutils literal notranslate">font.sans-serif</code> or <code class="docutils literal notranslate">font.monospace</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 CMU Serif, CMU Sans Serif, etc.

When saving to <code class="docutils literal notranslate">.pgf</code>, the font configuration matplotlib used for the

layout of the figure is included in the header of the text file.

<div class="highlight-default notranslate"><div class="highlight"><pre>"""

=========

Pgf Fonts

=========

"""

import matplotlib.pyplot as plt

plt.rcParams.update({

"font.family": "serif",

"font.serif": [], # use latex default serif font

"font.sans-serif": ["DejaVu Sans"], # use a specific sans-serif font

})

plt.figure(figsize=(4.5, 2.5))

plt.plot(range(5))

plt.text(0.5, 2., "monospace", family="monospace")

plt.text(2.5, 2., "sans-serif", family="sans-serif")

plt.text(2.5, 1., "comic sans", family="Comic Sans MS")

plt.xlabel("µ is not $\\mu$")

plt.tight_layout(.5)

</pre></div>

</div>

<h2>Custom preamble<a class="headerlink" href="#custom-preamble" title="Permalink to this headline">¶</a></h2>

Full customization is possible by adding your own commands to the preamble.

Use the <code class="docutils literal notranslate">pgf.preamble</code> parameter if you want to configure the math fonts,

using <code class="docutils literal notranslate">unicode-math</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">pgf.rcfonts</code>.

<div class="highlight-default notranslate"><div class="highlight"><pre>"""

============

Pgf Preamble

============

"""

import matplotlib as mpl

mpl.use("pgf")

import matplotlib.pyplot as plt

plt.rcParams.update({

"font.family": "serif", # use serif/main font for text elements

"text.usetex": True, # use inline math for ticks

"pgf.rcfonts": False, # don't setup fonts from rc parameters

"pgf.preamble": [

"\\usepackage{units}", # load additional packages

"\\usepackage{metalogo}",

"\\usepackage{unicode-math}", # unicode math setup

r"\setmathfont{xits-math.otf}",

r"\setmainfont{DejaVu Serif}", # serif font via preamble

]

})

plt.xlabel("unicode text: я, ψ, €, ü, \\unitfrac[10]{°}{µm}")

plt.ylabel("\\XeLaTeX")

plt.legend(["unicode math: $λ=∑_i^∞ μ_i^2$"])

plt.tight_layout(.5)

</pre></div>

</div>

<h2>Choosing the TeX system<a class="headerlink" href="#choosing-the-tex-system" title="Permalink to this headline">¶</a></h2>

The TeX system to be used by matplotlib is chosen by the <code class="docutils literal notranslate">pgf.texsystem</code>

parameter. Possible values are <code class="docutils literal notranslate">'xelatex'</code> (default), <code class="docutils literal notranslate">'lualatex'</code> and

<code class="docutils literal notranslate">'pdflatex'</code>. Please note that when selecting pdflatex the fonts and

unicode handling must be configured in the preamble.

<div class="highlight-default notranslate"><div class="highlight"><pre>"""

=============

Pgf Texsystem

=============

"""

import matplotlib.pyplot as plt

plt.rcParams.update({

"pgf.texsystem": "pdflatex",

"pgf.preamble": [

r"\usepackage[utf8x]{inputenc}",

r"\usepackage[T1]{fontenc}",

r"\usepackage{cmbright}",

]

})

plt.text(0.5, 3., "serif", family="serif")

plt.xlabel(r"µ is not $\mu$")

plt.tight_layout(.5)

</pre></div>

</div>

<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>

<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 <a class="reference internal" href="../../faq/environment_variables_faq.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate">PATH</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">Environment Variables</a> and

<a class="reference internal" href="../../faq/environment_variables_faq.html#setting-windows-environment-variables">Setting environment variables in windows</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

<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>The <code class="docutils literal notranslate">pgf.preamble</code> rc setting 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">unicode-math</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">\setmathfont{xits-math.otf}</code> instead of <code class="docutils literal notranslate">\setmathfont{XITS Math}</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">.pgf</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">.pgf</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">.pdf</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">rasterized=True</code> keyword, or <code class="docutils literal notranslate">.set_rasterized(True)</code> as per

<a class="reference internal" href="../../gallery/misc/rasterization_demo.html">this example</a>.</li>

<li>If you still need help, please see <a class="reference internal" href="../../faq/troubleshooting_faq.html#reporting-problems">Getting help</a></li>

</ul>

<a class="reference download internal" href="../../_downloads/pgf.py" download=""><code class="xref download docutils literal notranslate">Download Python source code: pgf.py</code></a></div>

<a class="reference download internal" href="../../_downloads/pgf.ipynb" download=""><code class="xref download docutils literal notranslate">Download Jupyter notebook: pgf.ipynb</code></a></div>

</div>

Keywords: matplotlib code example, codex, python plot, pyplot

<a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a>

</div>

</div>

Last updated on Sep 21, 2018.

Created using

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

Doc version v3.0.0-12-gea132530f.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

pgf.html

Latest commit

History

pgf.html

File metadata and controls