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

History

774 lines (677 loc) · 46.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

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

<!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.5.0 documentation</title>

href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css">

href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">

href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">

title="Search within Matplotlib 3.5.0 documentation"

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

</head>

</a>

</div>

</button>

<a class="reference internal nav-link" href="../../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../../users/index.html">Usage guide</a>

</li>

<a class="reference internal nav-link" href="../../devel/index.html">Develop</a>

</li>

<a class="reference internal nav-link" href="../../users/release_notes.html">Release notes</a>

</li>

</ul>

</div>

<label class="sr-only">gitter</label>

</a>

</li>

<label class="sr-only">discourse</label>

</a>

</li>

<label class="sr-only">GitHub</label>

</a>

</li>

<label class="sr-only">twitter</label>

</a>

</li>

</ul>

</div>

</nav>

</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">

Usage Guide

</a>

</li>

</ul>

Pyplot tutorial

</a>

</li>

</ul>

Image tutorial

</a>

</li>

</ul>

The Lifecycle of a Plot

</a>

</li>

</ul>

Customizing Matplotlib with style sheets and rcParams

</a>

</li>

</ul>

Artist tutorial

</a>

</li>

</ul>

Legend guide

</a>

</li>

</ul>

Styling with cycler

</a>

</li>

</ul>

Customizing Figure Layouts Using GridSpec and Other Functions

</a>

</li>

</ul>

Constrained Layout Guide

</a>

</li>

</ul>

Tight Layout guide

</a>

</li>

</ul>

Autoscaling

</a>

</li>

</ul>

origin

and

extent

imshow

</code>

</a>

</li>

</ul>

Faster rendering by using blitting

</a>

</li>

</ul>

Path Tutorial

</a>

</li>

</ul>

Path effects guide

</a>

</li>

</ul>

Transformations Tutorial

</a>

</li>

</ul>

Specifying Colors

</a>

</li>

</ul>

Customized Colorbars Tutorial

</a>

</li>

</ul>

Creating Colormaps in Matplotlib

</a>

</li>

</ul>

Colormap Normalization

</a>

</li>

</ul>

Choosing Colormaps in Matplotlib

</a>

</li>

</ul>

Complex and semantic figure composition

</a>

</li>

</ul>

Text in Matplotlib Plots

</a>

</li>

</ul>

Text properties and layout

</a>

</li>

</ul>

Annotations

</a>

</li>

</ul>

Writing mathematical expressions

</a>

</li>

</ul>

Typesetting with XeLaTeX/LuaLaTeX

</a>

</li>

</ul>

Text rendering with LaTeX

</a>

</li>

</ul>

Overview of

mpl_toolkits.axes_grid1

</code>

</a>

</li>

</ul>

Overview of axisartist toolkit

</a>

</li>

</ul>

The mplot3d Toolkit

</a>

</li>

</ul>

</div>

</nav>

</div>

On this page

</div>

Multi-Page PDF Files

</a>

</li>

Font specification

</a>

</li>

Custom preamble

</a>

</li>

Choosing the TeX system

</a>

</li>

Troubleshooting

</a>

</li>

</ul>

</nav>

</div>

</div>

<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

switching the backend

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

</pre></div>

</div>

or by explicitly requesting the use of the <code class="docutils literal notranslate">pgf</code> backend

<div class="highlight-default notranslate"><div class="highlight"><pre>plt.savefig('figure.pdf', backend='pgf')

</pre></div>

</div>

or by registering it for handling pdf output

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

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

</pre></div>

</div>

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.

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

<a class="reference internal" href="../../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate">rcParams</code></a> that control the behavior of the pgf backend:

</colgroup>

<thead>

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

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

</tr>

</thead>

<tbody>

<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

<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">PdfPages</code></a>

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

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>

</section>

<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 <a class="reference internal" href="../../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate">rcParams</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">rcParams["font.serif"]</a></code> (default: <code class="docutils literal notranslate">['DejaVu Serif', 'Bitstream Vera Serif', 'Computer Modern Roman', 'New Century Schoolbook', 'Century Schoolbook L', 'Utopia', 'ITC Bookman', 'Bookman', 'Nimbus Roman No9 L', 'Times New Roman', 'Times', 'Palatino', 'Charter', 'serif']</code>),

<code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=font.sans-serif#a-sample-matplotlibrc-file">rcParams["font.sans-serif"]</a></code> (default: <code class="docutils literal notranslate">['DejaVu Sans', 'Bitstream Vera Sans', 'Computer Modern Sans Serif', 'Lucida Grande', 'Verdana', 'Geneva', 'Lucid', 'Arial', 'Helvetica', 'Avant Garde', 'sans-serif']</code>) or <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=font.monospace#a-sample-matplotlibrc-file">rcParams["font.monospace"]</a></code> (default: <code class="docutils literal notranslate">['DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Computer Modern Typewriter', 'Andale Mono', 'Nimbus Mono L', 'Courier New', 'Courier', 'Fixed', 'Terminal', '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",

# Use LaTeX default serif font.

"font.serif": [],

# Use specific cursive fonts.

"font.cursive": ["Comic Neue", "Comic Sans MS"],

})

fig, ax = plt.subplots(figsize=(4.5, 2.5))

ax.plot(range(5))

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

ax.text(2.5, 2., "sans-serif", family="DejaVu Sans") # Use specific sans font.

ax.text(2.5, 1., "comic", family="cursive")

ax.set_xlabel("µ is not $\\mu$")

fig.tight_layout(pad=.5)

</pre></div>

</div>

</section>

<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 <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=pgf.preamble#a-sample-matplotlibrc-file">rcParams["pgf.preamble"]</a></code> (default: <code class="docutils literal notranslate">''</code>) 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"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=pgf.rcfonts#a-sample-matplotlibrc-file">rcParams["pgf.rcfonts"]</a></code> (default: <code class="docutils literal notranslate">True</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": "\n".join([

r"\usepackage{url}", # load additional packages

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

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

])

})

ax.set_xlabel("unicode text: я, ψ, €, ü")

ax.set_ylabel(r"\url{https://matplotlib.org}")

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

</pre></div>

</div>

</section>

<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 <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=pgf.texsystem#a-sample-matplotlibrc-file">rcParams["pgf.texsystem"]</a></code> (default: <code class="docutils literal notranslate">'xelatex'</code>).

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

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

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

r"\usepackage{cmbright}",

]),

})

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

ax.set_xlabel(r"µ is not $\mu$")

</pre></div>

</div>

</section>

<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="../../users/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="../../users/faq/environment_variables_faq.html#environment-variables">Environment variables</a> and

<a class="reference internal" href="../../users/faq/environment_variables_faq.html#setting-windows-environment-variables">Setting environment variables in Windows</a> for details.</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">rcParams["pgf.preamble"]</a></code> (default: <code class="docutils literal notranslate">''</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">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="https://tex.stackexchange.com/q/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="https://tex.stackexchange.com/q/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>Various math fonts are compiled and rendered only if corresponding font

packages are loaded. Specifically, when using <code class="docutils literal notranslate">\mathbf{}</code> on Greek letters,

the default computer modern font may not contain them, in which case the

letter is not rendered. In such scenarios, the <code class="docutils literal notranslate">lmodern</code> package should be

loaded.</li>

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

</ul>

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

</div>

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

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

</section>

</div>

</main>

</div>

</div>

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.

</div>

</footer>

</body>

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