Welcome to the Project Jupyter documentation site. Jupyter is a large umbrella project that covers many different software offerings and tools, including the popular Jupyter Notebook and JupyterLab web-based notebook authoring and editing applications. The Jupyter project and its subprojects all center around providing tools (and standards) for interactive computing with computational notebooks.
What is a Notebook?#
Pictured: A computational notebook document, shown inside JupyterLab
Note: Read What is Jupyter? for a detailed look at Jupyter and notebooks.
A notebook is a shareable document that combines computer code, plain language descriptions, data, rich visualizations like 3D models, charts, graphs and figures, and interactive controls. A notebook, along with an editor (like JupyterLab), provides a fast interactive environment for prototyping and explaining code, exploring and visualizing data, and sharing ideas with others.
Where do I start?#
Most people begin with Jupyter by installing an editing application that fits their preferences, like JupyterLab or Jupyter Notebook, and making their first notebook document:
Jupyter Notebook offers a simplified, lightweight notebook authoring experience
JupyterLab offers a feature-rich, tabbed multi-notebook editing environment with additional tools like a customizable interface layout and system console
And more… read about additional notebook interfaces here!
You can also develop your own extensions or applications on top of existing Jupyter software. Check out the subproject sites below for more information.
More information#
These are a few high-level topics to help you learn more about the Jupyter community and ecosystem.
Sub-project documentation#
Individual sub-projects are typically organized around a key feature of the Jupyter ecosystem, and have their own community, documentation and governance. Below is a list of documentation for major parts of the Jupyter ecosystem.
nbclient - execution
nbconvert - conversion
nbviewer - viewing
nbdime - comparing and merging
nbgrader - grading
nbformat - modification and validation
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).
Try Jupyter Try in Your Browser. No Installation Needed. Next step: install Jupyter locally Usage Use and Configure How do I decide which packages I need? Advanced topics 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? Getting Access to Jupyter Managed Accounts Reference Custom mimetypes (MIME types) IPython Glossary ResourcesResources#
Site
Description
Jupyter website
Keep up to date on Jupyter
IPython website
Learn more about IPython
Jupyter Discourse forum
Start here for help and support questions
Jupyter Accessibility
Accessibility sub-project documentation
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
