Commit b654be30 authored by Willi Rath's avatar Willi Rath

Clarify that all also works remotely

parent 0c59598a
# How to work with JupyterLab everywhere
_This will walk you through the complete setup of JupyterLab and one or more
scientific Python computing environments on your local computer or on a remote
machine. Currently, only Linux / Unix and MacOSX is covered._
## Install the base environment and JupyterLab
_This will show how to download the installer, install a minimal Python
environment, and start JupyerLab. The installation will be (nearly) identical
for a local computer or for any Linux / Unix remote computer._
environment, and start JupyerLab. Execute the steps below on the computer
where the calculation should be performed (e.g., your local computer or a
computer in a remote computing centre)._
### Download and install Miniconda3
_(No matter if you want to work with Python 3, which you probably should, or
Python 2, the base environment should be Python 3.)_
Python 2, the **base environment should be Python 3**.)_
To download the latest installer, run
......@@ -70,6 +76,16 @@ Copy/paste this URL into your browser when you connect for the first time,
Copy the URL (from your shell!) to your web browser. You should see JupyterLab.
_**Note** that at this point, you only have a minimal Python 3 installation with
a functional JupyterLab frontend. To perform scientific analyses, you need to add one
or more environments with a selection of scientific software._
## Add a scientific Python environment and use it
......@@ -91,7 +107,7 @@ conda create -n py3_std python=3 numpy matplotlib scipy ipykernel
_(Do **always** install `ipykernel` into the environment, to make sure that
Jupyter recognizes the new environment as a kernel.)_
JupyterLab recognizes the new environment as a kernel.)_
### Use the environment in JupyterLab
......@@ -100,6 +116,19 @@ Above, we created a new environment `py3_std`. To use it, activate the `base`
environment and start JupyterLab. There, you should be able to create a new
notebook and choose the `py3_std` environment as its kernel.
_At this point, you know how to set up a full Python installation including a
JupyterLab front end in the `base` environment and one or more scientific
computing environments that can be used in real scientific analyses. The
instructions above work on any local or remote Linux / Unix or MacOSX machine.
Below, you'll learn how to connect to JupyterLab if you installed Python on a
remote machine that you can only connect to via SSH._
## Connect to JupyterLab running on a remote machine
......@@ -110,7 +139,7 @@ directly access its address._
### Start Jupyterlab on a remote machine
After installing Jupyter and your Python environments on a remote machine,
follow the instructions on how to (Start JupyterLab)[#start-jupyterlab] above.
follow the instructions on how to [Start JupyterLab](#start-jupyterlab) above.
But before pasting the URL provided by Jupyter into your browser, make sure to
follow the next steps.
......@@ -152,7 +181,9 @@ continue and if you do, `` will be added to `.ssh/known_hosts`.)
### Connect your browser to the remote JupyterLab
Now, you can paste the URL provided by JupyterLab into the tunneled browser.
Now, you can paste the URL (usually of the form
provided by JupyterLab into the tunneled browser.
## Appendix: Jargon
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment