matplotlib_devdocs/faq/osx_framework.html at first_commit · puwei0000/matplotlib_devdocs

History

478 lines (420 loc) · 21.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

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

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

<head>

<title>Working with Matplotlib on OSX — 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>

<a href="../mpl_toolkits/index.html" title="Toolkits"

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

<a href="virtualenv_faq.html" title="Working with Matplotlib in Virtual environments"

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

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

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

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

<li><a href="index.html" accesskey="U">The Matplotlib FAQ</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="#">Working with Matplotlib on OSX</a><ul>

<li><a class="reference internal" href="#introduction">Introduction</a></li>

<li><a class="reference internal" href="#short-version">Short version</a><ul>

<li><a class="reference internal" href="#virtualenv">VirtualEnv</a></li>

<li><a class="reference internal" href="#pyenv">Pyenv</a></li>

<li><a class="reference internal" href="#conda">Conda</a></li>

</ul>

</li>

<li><a class="reference internal" href="#long-version">Long version</a><ul>

<li><a class="reference internal" href="#pythonhome-function"><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> Function</a><ul>

<li><a class="reference internal" href="#pythonhome-and-jupyter"><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> and Jupyter</a></li>

<li><a class="reference internal" href="#pythonhome-script"><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> Script</a></li>

<li><a class="reference internal" href="#pythonw-compiler">PythonW Compiler</a></li>

</ul>

</li>

</ul>

</li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">The Matplotlib FAQ</a><ul>

<li>Previous: <a href="virtualenv_faq.html" title="previous chapter">Working with Matplotlib in Virtual environments</a></li>

<li>Next: <a href="../mpl_toolkits/index.html" title="next chapter">Toolkits</a></li>

</ul></li>

</ul>

</div>

<li><a href="../_sources/faq/osx_framework.rst.txt"

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<span id="osxframework-faq"></span><h1>Working with Matplotlib on OSX<a class="headerlink" href="#working-with-matplotlib-on-osx" title="Permalink to this headline">¶</a></h1>

<p class="topic-title first">Contents</p>

<li><a class="reference internal" href="#working-with-matplotlib-on-osx" id="id2">Working with Matplotlib on OSX</a><ul>

<li><a class="reference internal" href="#introduction" id="id3">Introduction</a></li>

<li><a class="reference internal" href="#short-version" id="id4">Short version</a><ul>

<li><a class="reference internal" href="#virtualenv" id="id5">VirtualEnv</a></li>

<li><a class="reference internal" href="#pyenv" id="id6">Pyenv</a></li>

<li><a class="reference internal" href="#conda" id="id7">Conda</a></li>

</ul>

</li>

<li><a class="reference internal" href="#long-version" id="id8">Long version</a><ul>

<li><a class="reference internal" href="#pythonhome-function" id="id9"><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> Function</a><ul>

<li><a class="reference internal" href="#pythonhome-and-jupyter" id="id10"><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> and Jupyter</a></li>

<li><a class="reference internal" href="#pythonhome-script" id="id11"><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> Script</a></li>

<li><a class="reference internal" href="#pythonw-compiler" id="id12">PythonW Compiler</a></li>

</ul>

</li>

</ul>

</li>

</ul>

</li>

</ul>

</div>

<span id="osxframework-introduction"></span><h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>

<p>On OSX, two different types of Python Builds exist: a regular build and a

framework build. In order to interact correctly with OSX through the native

GUI frameworks you need a framework build of Python.

At the time of writing the <code class="docutils literal"><span class="pre">macosx</span></code> and <code class="docutils literal"><span class="pre">WXAgg</span></code> backends require a

framework build to function correctly. This can result in issues for

a python installation not build as a framework and may also happen in

virtual envs and when using (Ana)Conda.

From Matplotlib 1.5 onwards the <code class="docutils literal"><span class="pre">macosx</span></code> backend

checks that a framework build is available and fails if a non framework

build is found. WX has a similar check build in.</p>

<p>Without this check a partially functional figure is created.

Among the issues with it is that it is produced in the background and

cannot be put in front of any other window. Several solutions and work

arounds exist see below.</p>

</div>

<h2>Short version<a class="headerlink" href="#short-version" title="Permalink to this headline">¶</a></h2>

<h3>VirtualEnv<a class="headerlink" href="#virtualenv" title="Permalink to this headline">¶</a></h3>

<p>If you are on Python 3, use

instead of <a class="reference external" href="https://virtualenv.pypa.io/en/latest/">virtualenv</a>:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">venv</span> <span class="n">my</span><span class="o">-</span><span class="n">virtualenv</span>

<span class="n">source</span> <span class="n">my</span><span class="o">-</span><span class="n">virtualenv</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>

</pre></div>

</div>

<p>Otherwise you will need one of the workarounds below.</p>

</div>

<h3>Pyenv<a class="headerlink" href="#pyenv" title="Permalink to this headline">¶</a></h3>

<p>If you are using pyenv and virtualenv you can enable your python version to be installed as a framework:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">PYTHON_CONFIGURE_OPTS</span><span class="o">=</span><span class="s2">"--enable-framework"</span> <span class="n">pyenv</span> <span class="n">install</span> <span class="n">x</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">x</span>

</pre></div>

</div>

<h3>Conda<a class="headerlink" href="#conda" title="Permalink to this headline">¶</a></h3>

<p>The default python provided in (Ana)Conda is not a framework

build. However, the Conda developers have made it easy to install

a framework build in both the main environment and in Conda envs.

To use this install python.app <code class="docutils literal"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">python.app</span></code> and

use <code class="docutils literal"><span class="pre">pythonw</span></code> rather than <code class="docutils literal"><span class="pre">python</span></code></p>

</div>

<h2>Long version<a class="headerlink" href="#long-version" title="Permalink to this headline">¶</a></h2>

<p>Unfortunately virtualenv creates a non

framework build even if created from a framework build of Python.

As documented above you can use venv as an alternative on Python 3.</p>

<p>The issue has been reported on the virtualenv bug tracker <a class="reference external" href="https://github.com/pypa/virtualenv/issues/54">here</a> and <a class="reference external" href="https://github.com/pypa/virtualenv/issues/609">here</a></p>

<p>Until this is fixed, one of the following workarounds can be used:</p>

<h3><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> Function<a class="headerlink" href="#pythonhome-function" title="Permalink to this headline">¶</a></h3>

<p>The best known work around is to use the non

virtualenv python along with the PYTHONHOME environment variable.

This can be done by defining a function in your <code class="docutils literal"><span class="pre">.bashrc</span></code> using</p>

<div class="code bash highlight-default"><div class="highlight"><pre><span></span>function frameworkpython {

if [[ ! -z "$VIRTUAL_ENV" ]]; then

PYTHONHOME=$VIRTUAL_ENV /usr/local/bin/python "$@"

else

/usr/local/bin/python "$@"

}

</pre></div>

</div>

<p>This function can then be used in all of your virtualenvs without having to

fix every single one of them.</p>

<p>With this in place you can run <code class="docutils literal"><span class="pre">frameworkpython</span></code> to get an interactive

framework build within the virtualenv. To run a script you can do

<code class="docutils literal"><span class="pre">frameworkpython</span> <span class="pre">test.py</span></code> where <code class="docutils literal"><span class="pre">test.py</span></code> is a script that requires a

framework build. To run an interactive <code class="docutils literal"><span class="pre">IPython</span></code> session with the framework

build within the virtual environment you can do <code class="docutils literal"><span class="pre">frameworkpython</span> <span class="pre">-m</span> <span class="pre">IPython</span></code></p>

<h4><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> and Jupyter<a class="headerlink" href="#pythonhome-and-jupyter" title="Permalink to this headline">¶</a></h4>

<p>This approach can be followed even if using <a class="reference external" href="https://jupyter.org/">Jupyter</a>

notebooks: you just need to setup a kernel with the suitable <code class="docutils literal"><span class="pre">PYTHONHOME</span></code>

definition. The <a class="reference external" href="https://github.com/mapio/jupyter-virtualenv-osx">jupyter-virtualenv-osx</a>

script automates the creation of such a kernel.</p>

</div>

<h4><code class="docutils literal"><span class="pre">PYTHONHOME</span></code> Script<a class="headerlink" href="#pythonhome-script" title="Permalink to this headline">¶</a></h4>

<p>An alternative work around borrowed from the <a class="reference external" href="https://wiki.wxpython.org/wxPythonVirtualenvOnMac">WX wiki</a>, is to use the non

virtualenv python along with the PYTHONHOME environment variable. This can be

implemented in a script as below. To use this modify <code class="docutils literal"><span class="pre">PYVER</span></code> and

<code class="docutils literal"><span class="pre">PATHTOPYTHON</span></code> and put the script in the virtualenv bin directory i.e.

<code class="docutils literal"><span class="pre">PATHTOVENV/bin/frameworkpython</span></code></p>

<div class="code bash highlight-default"><div class="highlight"><pre><span></span>#!/bin/bash

# what real Python executable to use

PYVER=2.7

PATHTOPYTHON=/usr/local/bin/

PYTHON=${PATHTOPYTHON}python${PYVER}

# find the root of the virtualenv, it should be the parent of the dir this script is in

ENV=`$PYTHON -c "import os; print(os.path.abspath(os.path.join(os.path.dirname(\"$0\"), '..')))"`

# now run Python with the virtualenv set as Python's HOME

export PYTHONHOME=$ENV

exec $PYTHON "$@"

</pre></div>

</div>

<p>With this in place you can run <code class="docutils literal"><span class="pre">frameworkpython</span></code> as above but will need to add this script

to every virtualenv</p>

</div>

<h4>PythonW Compiler<a class="headerlink" href="#pythonw-compiler" title="Permalink to this headline">¶</a></h4>

<p>In addition

<a class="reference external" href="https://github.com/gldnspud/virtualenv-pythonw-osx">virtualenv-pythonw-osx</a>

provides an alternative workaround which may be used to solve the issue.</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

osx_framework.html

Latest commit

History

osx_framework.html

File metadata and controls