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#
These are a few high-level topics to help you learn more about the Jupyter community and ecosystem.
Get started with Jupyter Notebook Try the notebook |
Sustainability and growth |
What is Jupyter? |
How to contribute to the projects |
Narratives of common deployment scenarios |
New features, upgrades, deprecation notes, and bug fixes |
An interactive Python kernel and REPL |
APIs |
Installation, Configuration, and Usage Documentation for users |
Documentation for advanced use-cases |
Sub-project documentation#
Sub-projects are major technical and community efforts, and generally have their own documentation for their communities. Below is a list of documentation for major parts of the Jupyter ecosystem.
User Interfaces
JupyterHub
Spawners: sudo, Docker, Kubernetes
IPython
Architecture and Specification
nbformat - Jupyter Notebook Format
jupyter-client - Jupyter Messaging Protocol
Deployment
Table of Contents#
The rest of the documentation on this site covers major use-cases of the Jupyter ecosystem, as well as topics that will help you navigate the various parts of the Jupyter community. For more in-depth documentation about a specific tool, we recommend checking out that tool’s documentation (see the list above).
Resources#
Site |
Description |
---|---|
Keep up to date on Jupyter |
|
Learn more about IPython |
|
Start here for help and support questions |
|
Accessibility sub-project documentation |
|
General discussion of Jupyter’s use |
|
Discussion of Jupyter’s use in education |
|
Promotes world-class, innovative, open source scientific software |
|
Please contribute to open science collaboration and sustainability |