mirror of
https://github.com/jupyter/notebook.git
synced 2024-12-15 04:00:34 +08:00
78 lines
4.6 KiB
Markdown
78 lines
4.6 KiB
Markdown
# Jupyter Notebook
|
|
|
|
[](https://groups.google.com/forum/#!forum/jupyter)
|
|
[](https://travis-ci.org/jupyter/notebook)
|
|
[](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
|
|
|
|
The Jupyter notebook is a web-based notebook environment for interactive
|
|
computing.
|
|
|
|
|
|
|
|
### Notice
|
|
Please note that this repository is currently maintained by a skeleton crew of maintainers from the Jupyter community. We encourage users to transition to JupyterLab, where more immediate support can occur. Our approach moving forward will be:
|
|
|
|
1. To maintain the security of the Jupyter Notebook. That means security-related issues and pull requests are our highest priority.
|
|
2. To address JupyterLab [feature parity issues](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22tag%3AFeature+Parity%22). As part of this effort, we are also working on a better [notebook-only experience](https://github.com/jupyterlab/jupyterlab/issues/8450) in JupyterLab for users who prefer the UI of the classic Jupyter Notebook.
|
|
3. To be responsive to the hard work of community members who have opened pull requests. We are triaging these PRs. We cannot support or maintain new features at this time, but we welcome security and other sustainability fixes.
|
|
|
|
If you have an open pull request with a new feature or if you were planning to open one, please consider shipping it as a [notebook extension](https://jupyter-notebook.readthedocs.io/en/stable/extending/) instead.
|
|
|
|
##### Alternatives to contributing to `notebook`
|
|
Additionally, please consider whether your contribution would be appropriate for either the underlying server for Jupyter front-ends, [jupyter_server](https://github.com/jupyter/jupyter_server) or in the [JupyterLab front-end](https://github.com/jupyterlab/jupyterlab).
|
|
|
|
### Jupyter notebook, the language-agnostic evolution of IPython notebook
|
|
Jupyter notebook is a language-agnostic HTML notebook application for
|
|
Project Jupyter. In 2015, Jupyter notebook was released as a part of
|
|
The Big Split™ of the IPython codebase. IPython 3 was the last major monolithic
|
|
release containing both language-agnostic code, such as the *IPython notebook*,
|
|
and language specific code, such as the *IPython kernel for Python*. As
|
|
computing spans across many languages, Project Jupyter will continue to develop the
|
|
language-agnostic **Jupyter notebook** in this repo and with the help of the
|
|
community develop language specific kernels which are found in their own
|
|
discrete repos.
|
|
[[The Big Split™ announcement](https://blog.jupyter.org/the-big-split-9d7b88a031a7)]
|
|
[[Jupyter Ascending blog post](https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e)]
|
|
|
|
## Installation
|
|
You can find the installation documentation for the
|
|
[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html).
|
|
The documentation for advanced usage of Jupyter notebook can be found
|
|
[here](https://jupyter-notebook.readthedocs.io/en/latest/).
|
|
|
|
For a local installation, make sure you have
|
|
[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
|
|
|
|
$ pip install notebook
|
|
|
|
## Usage - Running Jupyter notebook
|
|
|
|
### Running in a local installation
|
|
|
|
Launch with:
|
|
|
|
$ jupyter notebook
|
|
|
|
### Running in a remote installation
|
|
|
|
You need some configuration before starting Jupyter notebook remotely. See [Running a notebook server](https://jupyter-notebook.readthedocs.io/en/stable/public_server.html).
|
|
|
|
## Development Installation
|
|
|
|
See [`CONTRIBUTING.rst`](CONTRIBUTING.rst) for how to set up a local development installation.
|
|
|
|
## Contributing
|
|
|
|
If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](CONTRIBUTING.rst).
|
|
|
|
## Resources
|
|
- [Project Jupyter website](https://jupyter.org)
|
|
- [Online Demo at jupyter.org/try](https://jupyter.org/try)
|
|
- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)]
|
|
- [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/)
|
|
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
|
|
- [Issues](https://github.com/jupyter/notebook/issues)
|
|
- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)
|