Jupyter Project Documentation

Welcome to the Jupyter Project documentation. This website acts as “meta” documentation for the Jupyter ecosystem. It has a collection of resources to navigate the tools and communities in this ecosystem, and to help you get started.

Start Here

Get started with Jupyter Notebook Try the notebook	Community Sustainability and growth
Architecture What is Jupyter?	Contributor Guides How to contribute to the projects
Narratives and Use Cases Narratives of common deployment scenarios	Release Notes New features, upgrades, deprecation notes, and bug fixes
IPython An interactive Python kernel and REPL	Reference APIs
Installation, Configuration, and Usage Documentation for users	Advanced Documentation for advanced use-cases

Sub-project documentation

Jupyter User Interfaces

• Jupyter Notebook

• Jupyter console

• Qt console

JupyterHub

• JupyterHub

• configurable HTTP proxy

• dockerspawner

• ldapauthenticator

• oauthenticator

• sudospawner

Education

• nbgrader

Conversion and Formatting

• nbconvert

• nbformat

Kernels

• IPython

• IRkernel

• IJulia

• Community maintained kernels

IPython

• IPython

• ipykernel

• ipyparallel

Architecture

• jupyter_client

• jupyter_core

Deployment

• docker-stacks

• jupyter-sphinx-theme

• kernel_gateway

• nbviewer

• tmpnb

• traitlets

JupyterLab

• JupyterLab

• ipywidgets

Table of Contents

• Get Started
  • Try Jupyter
  • Install and Use
  • Running the Notebook

• Using Jupyter Tools
  • Installation
  • Use and Configure
  • How do I decide which packages I need?
  • Advanced topics

• Jupyter Projects
  • Jupyter Projects and Communities
  • More information

• Community
  • Jupyter Community Meetings
  • Jupyter communications
  • Governance
  • Code of conduct
  • Running Jupyter Events
  • What is a Jovyan?

• Contributing
  • Getting Started Contributing
  • Developer Guide
  • Documentation Guide
  • Communications Guide
  • IPython Development Guide (source: old IPython wiki)
  • Do I really have something to contribute to Jupyter?
  • What kinds of contributions can I make?

• Reference
  • Custom mimetypes (MIME types)
  • IPython
  • Glossary
  • Resources

Resources

Site	Description
Jupyter website	Keep up to date on Jupyter
IPython website	Learn more about IPython
jupyter/help repo	Start here for help and support questions
Jupyter mailing list	General discussion of Jupyter’s use
Jupyter in Education group	Discussion of Jupyter’s use in education
NumFocus	Promotes world-class, innovative, open source scientific software
Donate to Project Jupyter	Please contribute to open science collaboration and sustainability

Indices and tables

• Index

• Glossary

• Search Page

Get Started