matplotlib.github.com/3.5.2/tutorials/text/usetex.html at main · matplotlib/matplotlib.github.com

History

672 lines (602 loc) · 32.9 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

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

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

<head>

<title>Text rendering with LaTeX — Matplotlib 3.5.2 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.2 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">User 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">

Basic Usage

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

Constrained Layout Guide

</a>

</li>

</ul>

Tight Layout guide

</a>

</li>

</ul>

Arranging multiple Axes in a Figure

</a>

</li>

</ul>

Autoscaling

</a>

</li>

</ul>

<em>

origin

</em>

and

<em>

extent

</em>

imshow

</span>

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

pgf

</span>

</code>

backend

</a>

</li>

</ul>

Text rendering with LaTeX

</a>

</li>

</ul>

Overview of

mpl_toolkits.axes_grid1

</span>

</code>

</a>

</li>

</ul>

Overview of axisartist toolkit

</a>

</li>

</ul>

The mplot3d Toolkit

</a>

</li>

</ul>

</div>

</nav>

</div>

</div>

<i class="fas fa-list"></i> On this page

</div>

PostScript options

</a>

</li>

Possible hangups

</a>

</li>

Troubleshooting

</a>

</li>

</ul>

</nav>

</div>

</div>

<div>

<p>Click <a class="reference internal" href="#sphx-glr-download-tutorials-text-usetex-py"><span class="std std-ref">here</span></a>

to download the full example code</p>

</div>

<span id="sphx-glr-tutorials-text-usetex-py"></span><h1>Text rendering with LaTeX<a class="headerlink" href="#text-rendering-with-latex" title="Permalink to this headline">#</a></h1>

<p>Matplotlib can use LaTeX to render text. This is activated by setting

<code class="docutils literal notranslate"><span class="pre">text.usetex</span> <span class="pre">:</span> <span class="pre">True</span></code> in your rcParams, or by setting the <code class="docutils literal notranslate"><span class="pre">usetex</span></code> property

to True on individual <a class="reference internal" href="../../api/text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> objects. Text handling through LaTeX is slower

than Matplotlib's very capable <a class="reference internal" href="mathtext.html"><span class="doc">mathtext</span></a>, but

is more flexible, since different LaTeX packages (font packages, math packages,

etc.) can be used. The results can be striking, especially when you take care

to use the same fonts in your figures as in the main document.</p>

<p>Matplotlib's LaTeX support requires a working <a class="reference external" href="http://www.tug.org">LaTeX</a> installation. For

the *Agg backends, <a class="reference external" href="http://www.nongnu.org/dvipng/">dvipng</a> is additionally required; for the PS backend,

<a class="reference external" href="https://ctan.org/pkg/psfrag">PSfrag</a>, <a class="reference external" href="https://tug.org/texinfohtml/dvips.html">dvips</a> and <a class="reference external" href="https://ghostscript.com/">Ghostscript</a> are additionally required. For the PDF

and SVG backends, if LuaTeX is present, it will be used to speed up some

post-processing steps, but note that it is not used to parse the TeX string

itself (only LaTeX is supported). The executables for these external

dependencies must all be located on your <span class="target" id="index-0"></span><a class="reference internal" href="../../users/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>There are a couple of options to mention, which can be changed using

<a class="reference internal" href="../introductory/customizing.html"><span class="doc">rc settings</span></a>. Here is an example

matplotlibrc file:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">font</span><span class="o">.</span><span class="n">family</span> <span class="p">:</span> <span class="n">serif</span>

<span class="n">font</span><span class="o">.</span><span class="n">serif</span> <span class="p">:</span> <span class="n">Times</span><span class="p">,</span> <span class="n">Palatino</span><span class="p">,</span> <span class="n">New</span> <span class="n">Century</span> <span class="n">Schoolbook</span><span class="p">,</span> <span class="n">Bookman</span><span class="p">,</span> <span class="n">Computer</span> <span class="n">Modern</span> <span class="n">Roman</span>

<span class="n">font</span><span class="o">.</span><span class="n">sans</span><span class="o">-</span><span class="n">serif</span> <span class="p">:</span> <span class="n">Helvetica</span><span class="p">,</span> <span class="n">Avant</span> <span class="n">Garde</span><span class="p">,</span> <span class="n">Computer</span> <span class="n">Modern</span> <span class="n">Sans</span> <span class="n">Serif</span>

<span class="n">font</span><span class="o">.</span><span class="n">cursive</span> <span class="p">:</span> <span class="n">Zapf</span> <span class="n">Chancery</span>

<span class="n">font</span><span class="o">.</span><span class="n">monospace</span> <span class="p">:</span> <span class="n">Courier</span><span class="p">,</span> <span class="n">Computer</span> <span class="n">Modern</span> <span class="n">Typewriter</span>

<span class="n">text</span><span class="o">.</span><span class="n">usetex</span> <span class="p">:</span> <span class="n">true</span>

</pre></div>

</div>

<p>The first valid font in each family is the one that will be loaded. If the

fonts are not specified, the Computer Modern fonts are used by default. All of

the other fonts are Adobe fonts. Times and Palatino each have their own

accompanying math fonts, while the other Adobe serif fonts make use of the

Computer Modern math fonts. See the <a class="reference external" href="http://www.ctan.org/tex-archive/macros/latex/required/psnfss/psnfss2e.pdf">PSNFSS</a> documentation for more details.</p>

<p>To use LaTeX and select Helvetica as the default font, without editing

matplotlibrc use:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></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">"text.usetex"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>

<span class="s2">"font.family"</span><span class="p">:</span> <span class="s2">"sans-serif"</span><span class="p">,</span>

<span class="s2">"font.sans-serif"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"Helvetica"</span><span class="p">]})</span>

<span class="c1"># for Palatino and other serif fonts use:</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">"text.usetex"</span><span class="p">:</span> <span class="kc">True</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="s2">"Palatino"</span><span class="p">],</span>

<span class="c1"># It's also possible to use the reduced notation by directly setting font.family:</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">"text.usetex"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>

<span class="s2">"font.family"</span><span class="p">:</span> <span class="s2">"Helvetica"</span>

</pre></div>

</div>

<p>Currently, the supported fonts are:</p>

</colgroup>

<thead>

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

<th class="head"><p>fonts</p></th>

</tr>

</thead>

<tbody>

<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">'serif'</span></code></p></td>

<td><p><code class="docutils literal notranslate"><span class="pre">'New</span> <span class="pre">Century</span> <span class="pre">Schoolbook'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Bookman'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Times'</span></code>,

<code class="docutils literal notranslate"><span class="pre">'Palatino'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Charter'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Computer</span> <span class="pre">Modern</span> <span class="pre">Roman'</span></code></p></td>

</tr>

<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">'sans-serif'</span></code></p></td>

<td><p><code class="docutils literal notranslate"><span class="pre">'Helvetica'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Avant</span> <span class="pre">Garde'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Computer</span> <span class="pre">Modern</span>

<span class="pre">Serif'</span></code></p></td>

</tr>

<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">'cursive'</span></code></p></td>

<td><p><code class="docutils literal notranslate"><span class="pre">'Zapf</span> <span class="pre">Chancery'</span></code></p></td>

</tr>

<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">'monospace'</span></code></p></td>

<td><p><code class="docutils literal notranslate"><span class="pre">'Courier'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Computer</span> <span class="pre">Modern</span> <span class="pre">Typewriter'</span></code></p></td>

</tr>

</tbody>

</table>

<p>Here is the standard example,

<a class="reference internal" href="../../gallery/text_labels_and_annotations/tex_demo.html"><span class="doc">Rendering math equations using TeX</span></a>:</p>

</figure>

<p>Note that display math mode (<code class="docutils literal notranslate"><span class="pre">$$</span> <span class="pre">e=mc^2</span> <span class="pre">$$</span></code>) is not supported, but adding the

command <code class="docutils literal notranslate"><span class="pre">\displaystyle</span></code>, as in the above demo, will produce the same results.</p>

<p>Non-ASCII characters (e.g. the degree sign in the y-label above) are supported

to the extent that they are supported by <a class="reference external" href="https://ctan.org/pkg/inputenc">inputenc</a>.</p>

<p>Certain characters require special escaping in TeX, such as:</p>

</pre></div>

</div>

<p>Therefore, these characters will behave differently depending on

<code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>).</p>

</div>

<h2>PostScript options<a class="headerlink" href="#postscript-options" title="Permalink to this headline">#</a></h2>

<p>In order to produce encapsulated PostScript (EPS) files that can be embedded

in a new LaTeX document, the default behavior of Matplotlib is to distill the

output, which removes some PostScript operators used by LaTeX that are illegal

in an EPS file. This step produces results which may be unacceptable to some

users, because the text is coarsely rasterized and converted to bitmaps, which

are not scalable like standard PostScript, and the text is not searchable. One

workaround is to set <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=ps.distiller.res#a-sample-matplotlibrc-file"><span class="pre">rcParams["ps.distiller.res"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">6000</span></code>) to a higher value (perhaps 6000)

in your rc settings, which will produce larger files but may look better and

scale reasonably. A better workaround, which requires <a class="reference external" href="https://poppler.freedesktop.org/">Poppler</a> or <a class="reference external" href="http://www.xpdfreader.com/">Xpdf</a>, can

be activated by changing <code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=ps.usedistiller#a-sample-matplotlibrc-file"><span class="pre">rcParams["ps.usedistiller"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">None</span></code>) to <code class="docutils literal notranslate"><span class="pre">xpdf</span></code>. This alternative

produces PostScript without rasterizing text, so it scales properly, can be

edited in Adobe Illustrator, and searched text in pdf documents.</p>

</section>

<span id="usetex-hangups"></span><h2>Possible hangups<a class="headerlink" href="#possible-hangups" title="Permalink to this headline">#</a></h2>

<li><p>On Windows, the <span class="target" id="index-1"></span><a class="reference internal" href="../../users/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="../../users/faq/environment_variables_faq.html#environment-variables"><span class="std std-ref">Environment variables</span></a> and

<a class="reference internal" href="../../users/faq/environment_variables_faq.html#setting-windows-environment-variables"><span class="std std-ref">Setting environment variables in Windows</span></a> for details.</p></li>

<li><p>Using MiKTeX with Computer Modern fonts, if you get odd *Agg and PNG

results, go to MiKTeX/Options and update your format files</p></li>

<li><p>On Ubuntu and Gentoo, the base texlive install does not ship with

the type1cm package. You may need to install some of the extra

packages to get all the goodies that come bundled with other LaTeX

distributions.</p></li>

<li><p>Some progress has been made so Matplotlib uses the dvi files

directly for text layout. This allows LaTeX to be used for text

layout with the pdf and svg backends, as well as the *Agg and PS

backends. In the future, a LaTeX installation may be the only

external dependency.</p></li>

</ul>

</section>

<span id="usetex-troubleshooting"></span><h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">#</a></h2>

<li><p>Try deleting your <code class="file docutils literal notranslate"><span class="pre">.matplotlib/tex.cache</span></code> directory. If you don't know

where to find <code class="file docutils literal notranslate"><span class="pre">.matplotlib</span></code>, see <a class="reference internal" href="../../users/faq/troubleshooting_faq.html#locating-matplotlib-config-dir"><span class="std std-ref">matplotlib configuration and cache directory locations</span></a>.</p></li>

<li><p>Make sure LaTeX, dvipng and ghostscript are each working and on your

<li><p>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.</p></li>

<li><p><code class="docutils literal notranslate"><a class="reference external" href="../../tutorials/introductory/customizing.html?highlight=text.latex.preamble#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.latex.preamble"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">''</span></code>) is not officially supported. This

option provides lots of flexibility, and lots of ways to cause

problems. Please disable this option before reporting problems to

the mailing list.</p></li>

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

</ul>

<p><a class="reference download internal" download="" href="../../_downloads/0d107edc8c3e240a5bc4f7486b23afc1/usetex.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">usetex.py</span></code></a></p>

</div>

<p><a class="reference download internal" download="" href="../../_downloads/67444aa8e727dcf1b494799f62393f05/usetex.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">usetex.ipynb</span></code></a></p>

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

</section>

</div>

</main>

</div>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.5.2). For the latest version see <a href="https://matplotlib.org/stable/tutorials/text/usetex.html">https://matplotlib.org/stable/tutorials/text/usetex.html</a></div>

</p>

</div>

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

</p>

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

usetex.html

Latest commit

History

usetex.html

File metadata and controls