forked from scipy-lectures/scipy-lectures.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpreface.html
715 lines (684 loc) · 33 KB
/
preface.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>About the scipy lecture notes — Scipy lecture notes</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2018.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/copybutton.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="How to contribute" href="guide/index.html" />
<link rel="prev" title="Scipy Lecture Notes" href="index.html" />
<link rel="stylesheet"
href="https://unpkg.com/[email protected]/build/base-min.css">
<script type="text/javascript">
$(function () {
// Highlight the table of content as we scroll
sections = {},
i = 0,
url = document.URL.replace(/#.*$/, ""),
current_section = 0;
// Grab positions of our sections
$('.headerlink').each(function(){
sections[this.href.replace(url, '')] = $(this).offset().top - 50;
});
$(window).scroll(function(event) {
var pos = $(window).scrollTop();
// Highlight the current section
$('a.internal').parent().removeClass('active');
for(i in sections){
if(sections[i] > pos){
break;
};
if($('a.internal[href$="' + i + '"]').is(':visible')){
current_section = i;
};
}
$('a.internal[href$="' + current_section + '"]').parent().addClass('active');
$('a.internal[href$="' + current_section + '"]').parent().parent().parent().addClass('active');
$('a.internal[href$="' + current_section + '"]').parent().parent().parent().parent().parent().addClass('active');
});
});
</script>
</head>
<body>
<!-- Use the header to add javascript -->
<script type="text/javascript">
// Function to collapse the tip divs
function collapse_tip_div(obj){
// Update the representation on the tip div based on whether it
// has the 'collapsed' css class or not: we only want to
// collapse divs that are not already collapsed
if($(obj).hasClass("collapsed")) {
} else {
$(obj).find("p.summary").remove();
var content = $(obj).text();
var html = $(obj).html();
if(content.length > 40) {
if ($.browser.msie) {
// We start at '3' to avoid 'tip', as IE
// does not count whitespace
var content = content.substr(3, 50);
} else {
// We start at '5' to avoid 'tip '
var content = content.substr(5, 50);
}
}
$(obj).html('<p class="summary"><img src="_static/plus.png">' + content + '...</p>' + html);
}
}
</script>
<script type="text/javascript">
$(function () {
$(".tip")
.click(function(event){
$(this).toggleClass("collapsed");
// Change state of the global button
$('div.related li.transparent').removeClass('transparent')
$(this).find("p.summary").remove();
if($(this).hasClass("collapsed")) {
var content = $(this).text();
var html = $(this).html();
if(content.length > 40) {
if ($.browser.msie) {
// We start at '3' to avoid 'tip', as IE
// does not count whitespace
var content = content.substr(3, 50);
} else {
// We start at '5' to avoid 'tip '
var content = content.substr(5, 50);
}
}
$(this).html('<p class="summary"><img src="_static/plus.png">' + content + '...</p>' + html);
}
if (event.target.tagName.toLowerCase() != "a") {
return true; //Makes links clickable
}
});
});
</script>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="guide/index.html" title="How to contribute"
accesskey="N">next</a></li>
<li class="right" >
<a href="index.html" title="Scipy Lecture Notes"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Scipy lecture notes</a> »</li>
<!-- Insert a menu in the navigation bar -->
<li class="left">
<!-- On click toggle the 'tip' on or off-->
<a onclick="$('.tip').each(function (index, obj) {
collapse_tip_div(obj);
});
$('.tip').addClass('collapsed');
$('.left').addClass('transparent');">
<img src="_static/minus.png"
alt="Collapse to compact view" style="padding: 1ex;"/>
<span class="hiddenlink">Collapse document to compact view</span>
</a></li>
<li class="right edit_on_github"><a href="https://github.com/scipy-lectures/scipy-lecture-notes/edit/master/preface.rst">Edit
<span class="tooltip">
Improve this page:<br/>Edit it on Github.
</span>
</a>
</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="about-the-scipy-lecture-notes">
<h1>About the scipy lecture notes<a class="headerlink" href="#about-the-scipy-lecture-notes" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#authors" id="id1">Authors</a></li>
<li><a class="reference internal" href="#what-s-new" id="id2">What’s new</a></li>
<li><a class="reference internal" href="#license" id="id3">License</a></li>
<li><a class="reference internal" href="#contributing" id="id4">Contributing</a></li>
</ul>
</div>
<a class="reference external image-reference" href="http://dx.doi.org/10.5281/zenodo.31521"><img alt="https://zenodo.org/badge/doi/10.5281/zenodo.31521.svg" src="https://zenodo.org/badge/doi/10.5281/zenodo.31521.svg" /></a>
<style type="text/css">
div.section#authors ul.simple li,
div.section#requirements ul.simple li{
float: left;
min-width: 200px;
width: 30%;
margin-right: 1.25em;
}
/* Below is necessary to avoid messing up android font size */
@media only screen and (max-width: 1080px) and (-webkit-min-device-pixel-ratio: 2.5),
only screen and (max-width: 1080px) and (-o-min-device-pixel-ratio: 25/10),
only screen and (max-width: 1080px) and (min-resolution: 250dpi)
{
div.section#authors ul.simple li,
div.section#requirements ul.simple li{
float: none;
width: 100%;
min-width: 100%;
margin-right: 0pt;
}
}
div.section#authors ul.simple:after,
div.section#requirements ul.simple li:after {
display: block;
font-size: 0;
content: " ";
clear: both;
height: 1em;
}
</style><div class="section" id="authors">
<h2><a class="toc-backref" href="#id1">Authors</a><a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
<div class="section" id="editors">
<h3>Editors<a class="headerlink" href="#editors" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Gaël Varoquaux</li>
<li>Emmanuelle Gouillart</li>
<li>Olav Vahtras</li>
</ul>
</div>
<div class="section" id="chapter-authors">
<h3>Chapter authors<a class="headerlink" href="#chapter-authors" title="Permalink to this headline">¶</a></h3>
<p>Listed by alphabetical order.</p>
<ul class="simple">
<li>Christopher Burns</li>
<li>Adrian Chauve</li>
<li>Robert Cimrman</li>
<li>Christophe Combelles</li>
<li>André Espaze</li>
<li>Emmanuelle Gouillart</li>
<li>Mike Müller</li>
<li>Fabian Pedregosa</li>
<li>Didrik Pinte</li>
<li>Nicolas Rougier</li>
<li>Gaël Varoquaux</li>
<li>Pauli Virtanen</li>
<li>Zbigniew Jędrzejewski-Szmek</li>
<li>Valentin Haenel (editor from 2011 to 2015)</li>
</ul>
</div>
<div class="section" id="additional-contributions">
<h3>Additional Contributions<a class="headerlink" href="#additional-contributions" title="Permalink to this headline">¶</a></h3>
<p>Listed by alphabetical order</p>
<ul class="simple">
<li>arunpersaud</li>
<li>Lilian Besson</li>
<li>Matthew Brett</li>
<li>Lars Buitinck</li>
<li>Pierre de Buyl</li>
<li>Ozan Çağlayan</li>
<li>Adrien Chauve</li>
<li>Robert Cimrman</li>
<li>Christophe Combelles</li>
<li>David Cournapeau</li>
<li>Török Edwin</li>
<li>egens</li>
<li>André Espaze</li>
<li>Loïc Estève</li>
<li>Corey Farwell</li>
<li>Olivier Georg</li>
<li>Daniel Gerigk</li>
<li>Robert Gieseke</li>
<li>Philip Gillißen</li>
<li>Ralf Gommers</li>
<li>Emmanuelle Gouillart</li>
<li>Julia Gustavsen</li>
<li>Valentin Haenel</li>
<li>Bruno Hanzen</li>
<li>Pierre Haessig</li>
<li>Michael Hartmann</li>
<li>Jonathan Helmus</li>
<li>Tarek Hoteit</li>
<li>Gert-Ludwig Ingold</li>
<li>Zbigniew Jędrzejewski-Szmek</li>
<li>Thouis (Ray) Jones</li>
<li>jorgeprietoarranz</li>
<li>kikocorreoso</li>
<li>Greg Kiar</li>
<li>Vince Knight</li>
<li>LFP6</li>
<li>John McLaughlin</li>
<li>mhemantha</li>
<li>Mohammad</li>
<li>negm</li>
<li>John B Nelson</li>
<li>nicoguaro</li>
<li>Sergio Oller</li>
<li>Theofilos Papapanagiotou</li>
<li>patniharshit</li>
<li>Fabian Pedregosa</li>
<li>Philippe Pepiot</li>
<li>Tiago M. D. Pereira</li>
<li>Nicolas Pettiaux</li>
<li>Didrik Pinte</li>
<li>reverland</li>
<li>Maximilien Riehl</li>
<li>Kristian Rother</li>
<li>Nicolas P. Rougier</li>
<li>Nicolas Rougier</li>
<li>Rutzmoser</li>
<li>João Felipe Santos</li>
<li>Helen Sherwood-Taylor</li>
<li>Scott Staniewicz</li>
<li>Shoeboxam</li>
<li>Simon</li>
<li>solarjoe</li>
<li>ssmiller</li>
<li>strpeter</li>
<li>Bartosz Telenczuk</li>
<li>Wes Turner</li>
<li>Akihiro Uchida</li>
<li>Utkarsh Upadhyay</li>
<li>Olav Vahtras</li>
<li>Gael Varoquaux</li>
<li>Nelle Varoquaux</li>
<li>Olivier Verdier</li>
<li>VirgileFritsch</li>
<li>Pauli Virtanen</li>
<li>Yosh Wakeham</li>
<li>Stefan van der Walt</li>
<li>yasutomo57jp</li>
</ul>
</div>
</div>
<div class="section" id="what-s-new">
<h2><a class="toc-backref" href="#id2">What’s new</a><a class="headerlink" href="#what-s-new" title="Permalink to this headline">¶</a></h2>
<div class="section" id="release-2018-1-september-2018">
<h3>Release 2018.1 (September 2018)<a class="headerlink" href="#release-2018-1-september-2018" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Fix wordings, typos, colours (Pierre de Buyl, Greg Kiar, Olav Vahtras
Kristian Rother)</li>
<li>Fix interpolation example code (Scott Staniewicz)</li>
<li>Fix CSS for high density displays (Gaël Varoquaux)</li>
<li>Generate indexing figures with PyX (Gert Ingold)</li>
<li>Warn clearly against the use of Python 2 (Bruno Hanzen)</li>
<li>Update external links (Bruno Hanzen)</li>
<li>Update versions of dependencies: sphinx-gallery, pandas, statsmodels
(Gaël Varoquaux)</li>
</ul>
</div>
<div class="section" id="release-2017-1-october-2017">
<h3>Release 2017.1 (October 2017)<a class="headerlink" href="#release-2017-1-october-2017" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Update optimization chapter (Michael Hartmann, Gaël Varoquaux)</li>
<li>Update SymPy chapter (Vince Knight)</li>
<li>Update advanced NumPy (Bartosz Teleńczuk)</li>
<li>Update scikit-learn chapter (Gaël Varoquaux)</li>
<li>Update SciPy chapter (Gaël Varoquaux)</li>
<li>Make ‘>>>’ in the prompts unselectable (Pierre de Buyl)</li>
<li>Use common package requirements for pip and conda and improve the build
instructions (Gert-Ludwig Ingold, Vince Knight, Pierre de Buyl)</li>
<li>Set up Circle CI (Loïc Estève)</li>
<li>Improved support for Python 3 integer divisions and calls to print (Loïc
Estève, Gert-Ludwig Ingold, Pierre de Buyl, Gaël Varoquaux)</li>
<li>Change test runner to pytest (Pierre de Buyl)</li>
<li>Replace the plot directive by sphinx-gallery (Gert-Ludwig Ingold)</li>
</ul>
</div>
<div class="section" id="release-2016-1-september-2016">
<h3>Release 2016.1 (September 2016)<a class="headerlink" href="#release-2016-1-september-2016" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Rework of intro chapter (Gaël Varoquaux)</li>
<li>Integrate sphinx-gallery: examples are now Jupyter notebooks (Gaël
Varoquaux, Gert-Ludwig Ingold, Óscar Nájera)</li>
<li>Better Python 3 tests and support (Gert-Ludwig Ingold)</li>
<li>Adapt examples to Matplotlib 1.5 (Gaël Varoquaux)</li>
<li>Modernize numpy chapter (Bartosz Telenczuk)</li>
</ul>
</div>
<div class="section" id="release-2015-3-november-2015">
<h3>Release 2015.3 (November 2015)<a class="headerlink" href="#release-2015-3-november-2015" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Collapsed sidebar can now pop up for mid-sized display (Gaël Varoquaux)</li>
<li>Replaced pictures of Lena by racoon face (Thouis Jones)</li>
</ul>
</div>
<div class="section" id="release-2015-2-october-2015">
<h3>Release 2015.2 (October 2015)<a class="headerlink" href="#release-2015-2-october-2015" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Authors on cover ordered as in bibtex entry (Nicolas Rougier)</li>
<li>Better rendering on mobile (Gaël Varoquaux)</li>
<li>Fix restructured text markup errors (Olav Vahtras)</li>
</ul>
</div>
<div class="section" id="release-2015-1-september-2015">
<h3>Release 2015.1 (September 2015)<a class="headerlink" href="#release-2015-1-september-2015" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>New chapter on statistics with Python (Gaël Varoquaux)</li>
<li>Better layout in PDF (Gaël Varoquaux)</li>
<li>New HTML layout, simplified formatting, mobile-friendly and sidebar
(Gaël Varoquaux, Nelle Varoquaux)</li>
<li>Logos on the HTML front page and on the PDF cover (Nicolas Rougier)</li>
<li>Python 3 compatible code (Gaël Varoquaux, Olav Vahtras)</li>
<li>Code put up to date for more recent versions of project (Pierre de
Buyl, Emmanuelle Gouillart, Gert-Ludwig Ingold, Nicolas Pettiaux, Olav
Vahtras, Gaël Varoquaux, Nelle Varoquaux)</li>
<li>Matplotlib updated with removal of deprecated pylab interface (Nicolas
Rougier)</li>
</ul>
</div>
<div class="section" id="release-2013-2-21-august-2013">
<h3>Release 2013.2 (21 August 2013)<a class="headerlink" href="#release-2013-2-21-august-2013" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Numpy chapter simplified (Valentin Haenel)</li>
<li>New layout for the HTML rendering (Gaël Varoquaux)</li>
</ul>
</div>
<div class="section" id="release-2013-1-10-feb-2013">
<h3>Release 2013.1 (10 Feb 2013)<a class="headerlink" href="#release-2013-1-10-feb-2013" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Improvements to the advanced image manipulation chapter (Emmanuelle Gouillart)</li>
<li>Upgrade of the introductory language chapter (Valentin Haenel)</li>
<li>Upgrade of the introductory numpy chapter (Valentin Haenel)</li>
<li>New advanced chapter on interfacing with C (Valentin Haenel)</li>
<li>Minor fixes and improvements in various places (Robert Gieseke, Ozan Çağlayan,
Sergio Oller, kikocorreo, Valentin Haenel)</li>
</ul>
</div>
<div class="section" id="release-2012-3-26-nov-2012">
<h3>Release 2012.3 (26 Nov 2012)<a class="headerlink" href="#release-2012-3-26-nov-2012" title="Permalink to this headline">¶</a></h3>
<p>This release integrates the changes written for the Euroscipy conference:</p>
<ul class="simple">
<li>Matplotlib chapter completely redone (Nicolas Rougier, Gaël Varoquaux)</li>
<li>New advanced chapter on mathematical optimization (Gaël Varoquaux)</li>
<li>Mayavi chapter redone (Gaël Varoquaux)</li>
<li>Front page layout slightly improved: folding TOC (Gaël Varoquaux)</li>
</ul>
</div>
<div class="section" id="release-2012-2-22-jun-2012">
<h3>Release 2012.2 (22 Jun 2012)<a class="headerlink" href="#release-2012-2-22-jun-2012" title="Permalink to this headline">¶</a></h3>
<p>Minor release with a few clean ups (Gael Varoquaux).</p>
</div>
<div class="section" id="release-2012-1-20-jun-2012">
<h3>Release 2012.1 (20 Jun 2012)<a class="headerlink" href="#release-2012-1-20-jun-2012" title="Permalink to this headline">¶</a></h3>
<p>This is a minor release with many clean ups. In particular, clean up of
the layout (Gael Varoquaux), shortening of the numpy chapters and
deduplications across the intro and advanced chapters (Gael Varoquaux)
and doctesting of all the code (Gael Varoquaux).</p>
</div>
<div class="section" id="release-2012-0-22-apr-2012">
<h3>Release 2012.0 (22 Apr 2012)<a class="headerlink" href="#release-2012-0-22-apr-2012" title="Permalink to this headline">¶</a></h3>
<p>This is a minor release with a few clean ups. In particular, clean up the
scikit-learn chapter (Lars Buitinck), more informative section titles
(Gael Varoquaux), and misc fixes (Valentin Haenel, Virgile Fritsch).</p>
</div>
<div class="section" id="release-2011-1-16-oct-2011">
<h3>Release 2011.1 (16 Oct 2011)<a class="headerlink" href="#release-2011-1-16-oct-2011" title="Permalink to this headline">¶</a></h3>
<p>This release is a reworked version of the Euroscipy 2011 tutorial. Layout
has been cleaned and optimized (Valentin Haenel and many others), the Traits
chapter has been merged in (Didrik Pinte)</p>
</div>
<div class="section" id="release-2011-1-sept-2011">
<h3>Release 2011 (1 Sept 2011)<a class="headerlink" href="#release-2011-1-sept-2011" title="Permalink to this headline">¶</a></h3>
<p>This release is used for the Euroscipy 2011 tutorial. The numpy
introductory chapter has been rewamped (Pauli Virtanen). The outline of
the introductory chapters has been simplified (Gaël Varoquaux). Advanced
chapters have been added: advanced Python constructs (Zbigniew
Jędrzejewski-Szmek), debugging code (Gaël Varoquaux), optimizing code
(Gaël Varoquaux), image processing (Emmanuelle Gouillart), scikit-learn
(Fabian Pedregosa).</p>
</div>
</div>
<div class="section" id="license">
<h2><a class="toc-backref" href="#id3">License</a><a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>All code and material is licensed under a</p>
<p>Creative Commons Attribution 4.0 International License (CC-by)</p>
<p><a class="reference external" href="http://creativecommons.org/licenses/by/4.0/">http://creativecommons.org/licenses/by/4.0/</a></p>
<p>See the AUTHORS.rst file for a list of contributors.</p>
</div>
<div class="section" id="contributing">
<h2><a class="toc-backref" href="#id4">Contributing</a><a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
<p>The SciPy lecture notes are a community-based effort and require constant
maintenance and improvements. New contributions such as wording
improvements or inclusion of new topics are welcome.</p>
<div class="section" id="contributing-guide">
<h3>Contributing guide<a class="headerlink" href="#contributing-guide" title="Permalink to this headline">¶</a></h3>
<p>The directory <code class="docutils literal"><span class="pre">guide</span></code> contains instructions on how to contribute:</p>
<div class="topic">
<p class="topic-title first"><strong>Example chapter</strong></p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="guide/index.html">How to contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#id1">How to contribute ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#using-github">Using GitHub</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#keeping-it-concise-collapsing-paragraphs">Keeping it concise: collapsing paragraphs</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#figures-and-code-examples">Figures and code examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#using-markup">Using Markup</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#linking-to-package-documentations">Linking to package documentations</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#chapter-section-subsection-paragraph">Chapter, section, subsection, paragraph</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#admonitions">Admonitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#clearing-floats">Clearing floats</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/index.html#references">References</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="section" id="building-instructions">
<h3>Building instructions<a class="headerlink" href="#building-instructions" title="Permalink to this headline">¶</a></h3>
<p>To generate the html output for on-screen display, Type:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">make html</span>
<div class="newline"></div></pre></div>
</div>
<p>the generated html files can be found in <code class="docutils literal"><span class="pre">build/html</span></code></p>
<p>The first build takes a long time, but information is cached and
subsequent builds will be faster.</p>
<p>To generate the pdf file for printing:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">make pdf</span>
<div class="newline"></div></pre></div>
</div>
<p>The pdf builder is a bit difficult and you might have some TeX errors.
Tweaking the layout in the <code class="docutils literal"><span class="pre">*.rst</span></code> files is usually enough to work
around these problems.</p>
<div class="section" id="requirements">
<h4>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h4>
<p>A complete list of requirements with information on the versions presently used
to build the SciPy lecture notes, can be inferred from the
<a class="reference download internal" href="_downloads/requirements.txt" download=""><code class="xref download docutils literal"><span class="pre">requirements</span> <span class="pre">file</span></code></a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">numpy==1.11</span>
<div class="newline"></div><span class="s2">scipy==0.19</span>
<div class="newline"></div><span class="s2">scikit-learn==0.18</span>
<div class="newline"></div><span class="s2">matplotlib==1.5</span>
<div class="newline"></div><span class="s2">scikit-image==0.13</span>
<div class="newline"></div><span class="s2">sympy==1.0</span>
<div class="newline"></div><span class="s2">statsmodels==0.8</span>
<div class="newline"></div><span class="s2">seaborn==0.7</span>
<div class="newline"></div><span class="s2">pandas==0.20</span>
<div class="newline"></div><span class="s2">pytest>=3.2.1</span>
<div class="newline"></div><span class="s2">sphinx==1.6.3</span>
<div class="newline"></div><span class="s2">coverage==4.4.1</span>
<div class="newline"></div><span class="s2">pillow</span>
<div class="newline"></div><span class="s2"># For conda, pip installable</span>
<div class="newline"></div><span class="s2">sphinx-gallery==0.2.0</span>
<div class="newline"></div></pre></div>
</div>
<p>The installation instructions below cover (i) Debian/Ubuntu with miniconda as this is the
method we use to test and build the material and (ii) generic instructions using pip.</p>
<div class="topic">
<p class="topic-title first"><strong>Building on Debian/Ubuntu</strong></p>
<p>The environment needed to create an html version of the SciPy lecture notes
can be based on miniconda. We first download the latest version of miniconda
and rename it to <code class="docutils literal"><span class="pre">miniconda.sh</span></code> for simplicity:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh</span>
<div class="newline"></div></pre></div>
</div>
<p>To ensure that the file has been downloaded correctly, one can compare the
MD5 sum obtained by means of:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">md5sum miniconda.sh</span>
<div class="newline"></div></pre></div>
</div>
<p>with the value listed on <a class="reference external" href="https://repo.continuum.io/miniconda/">https://repo.continuum.io/miniconda/</a> . Miniconda can
now be installed:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">bash miniconda.sh</span>
<div class="newline"></div></pre></div>
</div>
<p>Review the license agreement and choose a target directory (here we assume it
to be <code class="docutils literal"><span class="pre">$HOME/miniconda3</span></code>). Unless you intend to work more extensively with
miniconda, you do not want to modify <code class="docutils literal"><span class="pre">.bashrc</span></code>. In this case, you need:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">export PATH=$HOME/miniconda3/bin:$PATH</span>
<div class="newline"></div></pre></div>
</div>
<p>to find the correct binaries. Note that the path depends on the target directory
chosen above.</p>
<p>Now, we use <code class="docutils literal"><span class="pre">environment.yml</span></code> from the main directory of the <code class="docutils literal"><span class="pre">scipy-lecture-notes</span></code>
repository to install the required dependencies. Note that <code class="docutils literal"><span class="pre">environment.yml</span></code> yields
an environment named <code class="docutils literal"><span class="pre">testenv</span></code>. If you prefer a more telling name, make a copy of
<code class="docutils literal"><span class="pre">environment.yml</span></code>, replace <code class="docutils literal"><span class="pre">testenv</span></code> in line 4 by a more appropriate name and use
this name in the following instead of <code class="docutils literal"><span class="pre">testenv</span></code>. The conda environment is created
by:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">conda env create -f environment.yml</span>
<div class="newline"></div></pre></div>
</div>
<p>Now, the environment can be activated:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">source activate testenv</span>
<div class="newline"></div></pre></div>
</div>
<p>and deactivated:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">source deactivate</span>
<div class="newline"></div></pre></div>
</div>
<p>With an activated environment, you are now able to produce the html version of the
SciPy as explained above. Generating a pdf version requires the system packages
<code class="docutils literal"><span class="pre">texlive</span></code>, <code class="docutils literal"><span class="pre">texlive-latex-extra</span></code>, <code class="docutils literal"><span class="pre">texlive-fonts-extra</span></code>, and <code class="docutils literal"><span class="pre">latexmk</span></code>.</p>
</div>
<div class="topic">
<p class="topic-title first"><strong>Installing the Python packages with pip</strong></p>
<p><a class="reference external" href="https://pip.pypa.io/">pip</a> is the recommended tool to install Python
packages. However, a number of packages must be installed from the system. Install
Python, the Python “headers” (the <cite>python3-dev</cite> package on Debian, for instance), a C
development environment, <a class="reference external" href="https://www.gnu.org/software/make/">GNU Make</a>, a full LaTeX
distribution (e.g. <a class="reference external" href="https://www.tug.org/texlive/">TeX Live</a> with extra fonts and
utilities) and <a class="reference external" href="https://git-scm.com/">git</a>.</p>
<p>The remaining software can be installed with <cite>pip</cite>. Depending on the configuration, the
probably most convenient and safe way to proceed is with:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">pip install --user -r requirements.txt</span>
<div class="newline"></div></pre></div>
</div>
<p>This will install the software in a local directory belonging to the user and will not
interfere with system-wide Python packages.</p>
</div>
<p><div style="clear: both"></div></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div class="sidebartoc">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">About the scipy lecture notes</a><ul>
<li><a class="reference internal" href="#authors">Authors</a><ul>
<li><a class="reference internal" href="#editors">Editors</a></li>
<li><a class="reference internal" href="#chapter-authors">Chapter authors</a></li>
<li><a class="reference internal" href="#additional-contributions">Additional Contributions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#what-s-new">What’s new</a><ul>
<li><a class="reference internal" href="#release-2018-1-september-2018">Release 2018.1 (September 2018)</a></li>
<li><a class="reference internal" href="#release-2017-1-october-2017">Release 2017.1 (October 2017)</a></li>
<li><a class="reference internal" href="#release-2016-1-september-2016">Release 2016.1 (September 2016)</a></li>
<li><a class="reference internal" href="#release-2015-3-november-2015">Release 2015.3 (November 2015)</a></li>
<li><a class="reference internal" href="#release-2015-2-october-2015">Release 2015.2 (October 2015)</a></li>
<li><a class="reference internal" href="#release-2015-1-september-2015">Release 2015.1 (September 2015)</a></li>
<li><a class="reference internal" href="#release-2013-2-21-august-2013">Release 2013.2 (21 August 2013)</a></li>
<li><a class="reference internal" href="#release-2013-1-10-feb-2013">Release 2013.1 (10 Feb 2013)</a></li>
<li><a class="reference internal" href="#release-2012-3-26-nov-2012">Release 2012.3 (26 Nov 2012)</a></li>
<li><a class="reference internal" href="#release-2012-2-22-jun-2012">Release 2012.2 (22 Jun 2012)</a></li>
<li><a class="reference internal" href="#release-2012-1-20-jun-2012">Release 2012.1 (20 Jun 2012)</a></li>
<li><a class="reference internal" href="#release-2012-0-22-apr-2012">Release 2012.0 (22 Apr 2012)</a></li>
<li><a class="reference internal" href="#release-2011-1-16-oct-2011">Release 2011.1 (16 Oct 2011)</a></li>
<li><a class="reference internal" href="#release-2011-1-sept-2011">Release 2011 (1 Sept 2011)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#license">License</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a><ul>
<li><a class="reference internal" href="#contributing-guide">Contributing guide</a></li>
<li><a class="reference internal" href="#building-instructions">Building instructions</a><ul>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="script_container">
<script>
(function() {
var cx = '004523248466141510607:hgv2yimrahw';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
'//cse.google.com/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
<gcse:search></gcse:search>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="guide/index.html" title="How to contribute"
>next</a></li>
<li class="right" >
<a href="index.html" title="Scipy Lecture Notes"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Scipy lecture notes</a> »</li>
<!-- Insert a menu in the navigation bar -->
<li class="left">
<!-- On click toggle the 'tip' on or off-->
<a onclick="$('.tip').each(function (index, obj) {
collapse_tip_div(obj);
});
$('.tip').addClass('collapsed');
$('.left').addClass('transparent');">
<img src="_static/minus.png"
alt="Collapse to compact view" style="padding: 1ex;"/>
<span class="hiddenlink">Collapse document to compact view</span>
</a></li>
<li class="right edit_on_github"><a href="https://github.com/scipy-lectures/scipy-lecture-notes/edit/master/preface.rst">Edit
<span class="tooltip">
Improve this page:<br/>Edit it on Github.
</span>
</a>
</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2012,2013,2015,2016,2017,2018.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
</div>
</body>
</html>