Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation on using jupyverse #16190

Merged
merged 4 commits into from
May 1, 2024
Merged

Add documentation on using jupyverse #16190

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8fdfc80
Add documentation on using jupyverse
davidbrochart Apr 18, 2024
e8efb57
Review
davidbrochart Apr 19, 2024
3afacda
Add conda install instructions
davidbrochart Apr 26, 2024
60c571d
Merge branch 'main' into jupyverse
krassowski Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/source/getting_started/installation.rst
View file
Open in desktop
Expand Up @@ -98,6 +98,38 @@ Usage with JupyterHub
Read the details on our :ref:`JupyterLab on JupyterHub documentation page <jupyterhub>`.


Usage with Jupyverse
--------------------

`Jupyverse <https://github.com/jupyter-server/jupyverse/>`__ is a next-generation Jupyter server based on
davidbrochart marked this conversation as resolved.
Show resolved Hide resolved
`FastAPI <https://fastapi.tiangolo.com/>`__. It can be used instead of
`jupyter-server <https://github.com/jupyter-server/jupyter_server/>`__, the Jupyter server installed by default with JupyterLab.
Note that ``jupyter-server`` extensions won't work with ``jupyverse`` (for which there might be equivalent plugins).

You can install ``jupyverse`` with ``pip``:

.. code:: bash

pip install jupyverse[auth, jupyterlab]

or with ``conda``:

.. code:: bash

conda install -c conda-forge jupyverse fps-auth fps-jupyterlab

or with ``mamba``:
davidbrochart marked this conversation as resolved.
Show resolved Hide resolved

.. code:: bash

mamba install -c conda-forge jupyverse fps-auth fps-jupyterlab

And run it with:

.. code:: bash

jupyverse
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So will running jupyverse in the terminal run a JupyterLab session in my browser?

i.e. does jupyverse replace the jupyter lab command I use now? And, if so, can I pass all the same JupyterLab arguments to jupyverse?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So will running jupyverse in the terminal run a JupyterLab session in my browser?

If jupyverse was installed with pip install jupyverse[auth, jupyterlab], yes. If installed with pip install jupyverse[auth, notebook], it will run Jupyter Notebook.

i.e. does jupyverse replace the jupyter lab command I use now? And, if so, can I pass all the same JupyterLab arguments to jupyverse?

Yes, but arguments are different. More information is available in the documentation.


Supported browsers
------------------

Expand Down