matplotlib_devdocs/tutorials/text/usetex.html at first_commit · puwei0000/matplotlib_devdocs

History

447 lines (391 loc) · 23.8 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

<!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 2.0.2.post4416.dev0+g1df513f documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.0.2.post4416.dev0+g1df513f',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f documentation"

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

</head>

<body>

</map>

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

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

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

<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>

</ul>

</div>

</a>

<br/>

</a>

<br/>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<br/>

<h3><a href="../../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Text rendering With LaTeX</a><ul>

<li><a class="reference internal" href="#usetex-with-unicode">usetex with unicode</a></li>

<li><a class="reference internal" href="#postscript-options">Postscript options</a></li>

<li><a class="reference internal" href="#possible-hangups">Possible hangups</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>

</ul></li>

</ul>

</div>

<li><a href="../../_sources/tutorials/text/usetex.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</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>Rendering text with LaTeX in Matplotlib.</p>

<p>Matplotlib has the option to use LaTeX to manage all text layout. This

option is available with the following backends:</p>

</ul>

<p>The LaTeX option is activated by setting <code class="docutils literal"><span class="pre">text.usetex</span> <span class="pre">:</span> <span class="pre">True</span></code> in

your rc settings. Text handling with matplotlib’s LaTeX support is

slower than matplotlib’s very capable <a class="reference internal" href="mathtext.html#sphx-glr-tutorials-text-mathtext-py"><span class="std std-ref">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, <a class="reference external" href="http://www.nongnu.org/dvipng/">dvipng</a>

(which may be included with your LaTeX installation), and <a class="reference external" href="https://ghostscript.com/">Ghostscript</a>

(GPL Ghostscript 8.60 or later is recommended). The executables for these

external dependencies must all 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"><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="../01_introductory/customizing.html#sphx-glr-tutorials-01-introductory-customizing-py"><span class="std std-ref">rc

settings</span></a>. Here is an example matplotlibrc file:</p>

<div class="highlight-default"><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"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">rc</span>

<span class="n">rc</span><span class="p">(</span><span class="s1">'font'</span><span class="p">,</span><span class="o">**</span><span class="p">{</span><span class="s1">'family'</span><span class="p">:</span><span class="s1">'sans-serif'</span><span class="p">,</span><span class="s1">'sans-serif'</span><span class="p">:[</span><span class="s1">'Helvetica'</span><span class="p">]})</span>

<span class="c1">## for Palatino and other serif fonts use:</span>

<span class="c1">#rc('font',**{'family':'serif','serif':['Palatino']})</span>

<span class="n">rc</span><span class="p">(</span><span class="s1">'text'</span><span class="p">,</span> <span class="n">usetex</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

</pre></div>

</div>

<p>Here is the standard example, <code class="xref py py-obj docutils literal"><span class="pre">tex_demo.py</span></code>:</p>

</div>

<p>Note that display math mode (<code class="docutils literal"><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"><span class="pre">\displaystyle</span></code>, as in <code class="xref py py-obj docutils literal"><span class="pre">tex_demo.py</span></code>, will produce the same

results.</p>

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

</pre></div>

</div>

<p class="last">Therefore, these characters will behave differently depending on

the rcParam <code class="docutils literal"><span class="pre">text.usetex</span></code> flag.</p>

</div>

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

<p>It is also possible to use unicode strings with the LaTeX text manager, here is

an example taken from <code class="xref py py-obj docutils literal"><span class="pre">tex_demo.py</span></code>. The axis labels include Unicode text:</p>

<p class="caption"><span class="caption-text">TeX Unicode Demo</span></p>

</div>

<span id="usetex-postscript"></span><h2>Postscript options<a class="headerlink" href="#postscript-options" title="Permalink to this headline">¶</a></h2>

<p>In order to produce encapsulated postscript 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"><span class="pre">ps.distiller.res</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.foolabs.com/xpdf">Xpdf</a>, can be

activated by changing the <code class="docutils literal"><span class="pre">ps.usedistiller</span></code> rc setting to <code class="docutils literal"><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>

</div>

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

<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"><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>Using MiKTeX with Computer Modern fonts, if you get odd *Agg and PNG

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

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

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

</ul>

</div>

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

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

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

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

<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>Most problems reported on the mailing list have been cleared up by

upgrading <a class="reference external" href="https://ghostscript.com/">Ghostscript</a>. If possible, please try upgrading to the

latest release before reporting problems to the list.</li>

<li>The <code class="docutils literal"><span class="pre">text.latex.preamble</span></code> rc setting 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.</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>

<p><strong>Total running time of the script:</strong> ( 0 minutes 0.000 seconds)</p>

<a class="reference download internal" href="../../_downloads/usetex.py" download=""><code class="xref download docutils literal"><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></div>

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

</div>

<p class="sphx-glr-signature"><a class="reference external" href="https://sphinx-gallery.readthedocs.io">Generated by Sphinx-Gallery</a></p>

</div>

</div>

Last updated on Jul 16, 2017.

Created using <a

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

</div>

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

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

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

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

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

ga('send', 'pageview');

</script>

</body>

<!--Flipcause Integration v3.0// Flipcause Integration Instructions:

Install the following code block once in the website Header (after <head> tag) -->

<style>

.fc-black_overlay{

display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;

background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;

}

.fc-white_content {

opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;

position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;

}

.fc-main-box{

opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;

}

.fc-widget_close{

opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);

position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;

}

.floating_button{

display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;

position:fixed; z-index:999999; overflow: auto;

}

@keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-moz-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-webkit-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-o-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-ms-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; transform: translateY(20px);}

100% {opacity: 1; transform: translateY(0);}

}

@-moz-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -moz-transform: translateY(20px);}

100% {opacity: 1; -moz-transform: translateY(0);}

}

@-webkit-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -webkit-transform: translateY(20px);}

100% {opacity: 1; -webkit-transform: translateY(0);}

}

@-o-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -o-transform: translateY(20px);}

100% {opacity: 1; -o-transform: translateY(0);}

}

@-ms-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -ms-transform: translateY(20px);}

100% {opacity: 1; -ms-transform: translateY(0);}

}

</style>

function open_window(cause_id) {

var protocol=String(document.location.protocol);

var new_url;

if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){

new_url="https://www.flipcause.com/widget/"+cause_id

window.open(new_url);

}

else {

document.getElementById("fc-fade").style.display = "block";

document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";

document.getElementById("fc-fade").style.animation = "backfadesin 1s";

document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";

document.getElementById("fc-light").style.display = "block";

document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-light").style.animation = "fadesin 1.5s";

document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.display = "block";

document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.animation = "fadesin 1.5s";

document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.display = "block";

document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.animation = "fadesin 1.5s";

document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.display = "block";

document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;

}

function close_window() {

document.getElementById("fc-fade").style.display="none";

document.getElementById("fc-light").style.display="none";

document.getElementById("fc-main").style.display="none";

document.getElementById("fc-close").style.display="none";

document.getElementById("fc-myFrame").style.display="none";

}

</script>

</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;

border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>

</div>

</footer>

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