You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you are using a system-wide Python installation and you only want to install the notebook for you,
33
+
If you are using a system-wide Python installation and you only want to install the server for you,
57
34
you can add ``--user`` to the install commands.
58
35
59
-
Once you have done this, you can launch the master branch of Jupyter notebook
36
+
Once you have done this, you can launch the master branch of Jupyter server
60
37
from any directory in your system with::
61
38
62
-
jupyter notebook
63
-
64
-
Verification
65
-
^^^^^^^^^^^^
66
-
67
-
While running the notebook, select one of your notebook files (the file will have the extension ``.ipynb``).
68
-
In the top tab you will click on "Help" and then click on "About". In the pop window you will see information about the version of Jupyter that you are running. You will see "The version of the notebook server is:".
69
-
If you are working in development mode, you will see that your version of Jupyter notebook will include the word "dev".
If it does not include the word "dev", you are currently not working in development mode and should follow the steps below to uninstall and reinstall Jupyter.
39
+
jupyter server
75
40
76
41
Troubleshooting the Installation
77
42
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
78
43
79
-
If you do not see that your Jupyter Notebook is not running on dev mode, it's possible that you are
80
-
running other instances of Jupyter Notebook. You can try the following steps:
44
+
If you do not see that your Jupyter Server is not running on dev mode, it's possible that you are
45
+
running other instances of Jupyter Server. You can try the following steps:
81
46
82
-
1. Uninstall all instances of the notebook package. These include any installations you made using
47
+
1. Uninstall all instances of the jupyter_server package. These include any installations you made using
83
48
pip or conda
84
-
2. Run ``python3 -m pip install -e .`` in the notebook repository to install the notebook from there
49
+
2. Run ``python3 -m pip install -e .`` in the jupyter_server repository to install the jupyter_server from there
85
50
3. Run ``npm run build`` to make sure the Javascript and CSS are updated and compiled
86
-
4. Launch with ``python3 -m notebook --port 8989``, and check that the browser is pointing to ``localhost:8989``
51
+
4. Launch with ``python3 -m jupyter_server --port 8989``, and check that the browser is pointing to ``localhost:8989``
87
52
(rather than the default 8888). You don't necessarily have to launch with port 8989, as long as you use
88
53
a port that is neither the default nor in use, then it should be fine.
89
54
5. Verify the installation with the steps in the previous section.
90
55
91
-
92
-
Rebuilding JavaScript and CSS
93
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
94
-
95
-
There is a build step for the JavaScript and CSS in the notebook.
96
-
To make sure that you are working with up-to-date code, you will need to run
97
-
this command whenever there are changes to JavaScript or LESS sources::
98
-
99
-
npm run build
100
-
101
-
**IMPORTANT:** Don't forget to run ``npm run build`` after switching branches.
102
-
When switching between branches of different versions (e.g. ``4.x`` and
103
-
``master``), run ``pip install -e .``. If you have tried the above and still
104
-
find that the notebook is not reflecting the current source code, try cleaning
105
-
the repo with ``git clean -xfd`` and reinstalling with ``pip install -e .``.
106
-
107
-
Development Tip
108
-
"""""""""""""""
109
-
110
-
When doing development, you can use this command to automatically rebuild
111
-
JavaScript and LESS sources as they are modified::
112
-
113
-
npm run build:watch
114
-
115
-
Git Hooks
116
-
"""""""""
117
-
118
-
If you want to automatically update dependencies and recompile JavaScript and
119
-
CSS after checking out a new commit, you can install post-checkout and
120
-
post-merge hooks which will do it for you::
121
-
122
-
git-hooks/install-hooks.sh
123
-
124
-
See ``git-hooks/README.md`` for more details.
125
-
126
-
127
56
Running Tests
128
57
-------------
129
58
@@ -140,42 +69,19 @@ To run the Python tests, use::
140
69
141
70
If you want coverage statistics as well, you can run::
[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
35
19
36
-
$ pip install notebook
20
+
$ pip install jupyter_server
37
21
38
-
## Usage - Running Jupyter notebook
22
+
## Usage - Running Jupyter Server
39
23
40
24
### Running in a local installation
41
25
42
26
Launch with:
43
27
44
-
$ jupyter notebook
28
+
$ jupyter server
45
29
46
30
### Running in a remote installation
47
31
48
-
You need some configuration before starting Jupyter notebook remotely. See [Running a notebook server](http://jupyter-notebook.readthedocs.io/en/stable/public_server.html).
32
+
You need some configuration before starting Jupyter server remotely. See [Running a Jupyter server](http://jupyter-server.readthedocs.io/en/stable/public_server.html).
49
33
50
34
## Development Installation
51
35
@@ -58,8 +42,8 @@ If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](C
58
42
## Resources
59
43
-[Project Jupyter website](https://jupyter.org)
60
44
-[Online Demo at try.jupyter.org](https://try.jupyter.org)
61
-
-[Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/)[[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)]
45
+
-[Documentation for Jupyter Server](https://jupyter-server.readthedocs.io/en/latest/)[[PDF](https://media.readthedocs.org/pdf/jupyter-server/latest/jupyter-server.pdf)]
62
46
-[Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/)
63
47
-[Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html)[[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
0 commit comments