Jupyter Documentation - Read the Docs

Jupyter Documentation

Release 4.1.0

March 27, 2016

User Documentation

1 Try Jupyter

3

1.1 Ready to install Jupyter? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Installation

5

2.1 Installing Jupyter and Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.2 Installing Jupyter (I already have Python) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.3 Upgrading a Jupyter installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2.4 Installing kernels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.5 Next steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 Running the Notebook

9

4 Additional options

11

5 Migrating from IPython

13

5.1 Where have all my files gone? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.3 Imports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

6 Jupyter subprojects

17

6.1 Jupyter user interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

6.2 Kernels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

6.3 Formatting and conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

6.4 Education . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

6.5 Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

6.6 Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

7 Configuring Jupyter applications

19

7.1 Python config files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

7.2 Command line arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

8 Jupyter on your system

21

8.1 The jupyter command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

8.2 Jupyter directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

8.3 Data files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

8.4 Runtime files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

9 Contributing to the Code

23

9.1 A Note on Contributing to Open Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

i

9.2 How can I help? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 9.3 Contribution Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

10 Submitting a Bug

27

11 Submitting an Enhancement Proposal

29

12 Contributing to the Documentation

31

12.1 Preparing for your first contribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

12.2 Your first contribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

12.3 Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

13 Git and Github Resources

33

14 Contributing to the Jupyter Blog

35

14.1 Technical overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

14.2 Basic workflow from blog idea to published post . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

14.3 Creating a draft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

14.4 Draft review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

14.5 Editorial acceptance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

14.6 Publishing the post . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

14.7 Changing an existing post . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

15 Jupyter for Data Science

39

ii

Jupyter Documentation, Release 4.1.0

The Jupyter Notebook is a web application for interactive data science and scientific computing.

What's New in Jupyter Notebook Release 4.1 Announcement ? Cell toolbar selector moved to View menu ? Restart & Run All Cells added to Kernel menu ? Multiple-cell selection and actions including cut, copy, paste and execute ? Command palette added for executing Jupyter actions ? Find and replace added to Edit menu

To upgrade to the release: pip install notebook --upgrade or conda upgrade notebook

Using the Jupyter Notebook, you can author engaging documents that combine live-code with narrative text, equations, images, video, and visualizations. By encoding a complete and reproducible record of a computation, the documents can be shared with others on GitHub, Dropbox, and the Jupyter Notebook Viewer. The main documentation for Jupyter users is organized into several sections:

? User Documentation ? Jupyter Subprojects ? About Jupyter Contributor Documentation covers how to help with the development of Jupyter as well as technical details helpful for development. It also covers how to contribute to our documentation, blog, website, and newsletter.

User Documentation

1

Jupyter Documentation, Release 4.1.0

2

User Documentation

CHAPTER 1 Try Jupyter

Would you like to try Jupyter in your web browser? Go to . No installation is needed.

1.1 Ready to install Jupyter?

If you have tried Jupyter and like it, please use our detailed installation guide to install it on your computer.

3

Jupyter Documentation, Release 4.1.0

4

Chapter 1. Try Jupyter

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download