Skip to content
Snippets Groups Projects
Commit 1354fc63 authored by Swen Vermeul's avatar Swen Vermeul
Browse files

revised README

parent 1b4abca2
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 12 additions and 14 deletions
README.md
+ 12
− 14
View file @ 1354fc63
...@@ -15,10 +15,10 @@ If you haven't done yet: download the latest jupyter-openbis-extension from pip. ...@@ -15,10 +15,10 @@ If you haven't done yet: download the latest jupyter-openbis-extension from pip.
pip install --upgrade jupyter-openbis-extension pip install --upgrade jupyter-openbis-extension
``` ```
## Create a configuration file
This step is not really necessary, as you can define openBIS connections within the Jupyter notebook. However, if you need to connect to the same openBIS connections many times, this will become convenient.
Create a file `openbis-connections.yaml`. It should contain connection information to your server(s), for example:
**Create a configuration file**: `~/.jupyter/openbis-connections.yaml` It should contain connection information to your server(s), for example:
``` ```
connections: connections:
...@@ -34,7 +34,7 @@ connections: ...@@ -34,7 +34,7 @@ connections:
``` ```
**Note 1**: You do not need neither username nor password. With the current version, you are able to enter username and password directly from within a Jupyter notebook. **Note 1**: You do not need neither username nor password. With the current version, you are able to enter username and password directly from within a Jupyter notebook.
**Note 2**: You can place this file in any of these directories (on Mac OS X): **Note 2**: Place this file in any of these directories (on Mac OS X):
``` ```
/Users/your_username/jupyter-openbis-extension/notebooks /Users/your_username/jupyter-openbis-extension/notebooks
...@@ -52,29 +52,27 @@ The `config` section from the output lists the directories where your `openbis-c ...@@ -52,29 +52,27 @@ The `config` section from the output lists the directories where your `openbis-c
## Launching Jupyter notebook ## Launching Jupyter notebook
Now you are **ready to launch jupyter notebook!** Now you are ready to launch Jupyter notebook:
``` ```
$ jupyter notebook $ jupyter notebook --no-browser
``` ```
Observe the terminal. It should tell you which server(s) have been successfully connected (and which not): Observe the terminal. It should tell you which server(s) have been registered. If you provided a password, it will try to connect:
``` ```
$ jupyter notebook $ jupyter notebook
Registered: https://localhost:8443 Registered: https://localhost:8443
Cannot establish connection to: https://localhost:8443 Successfully connected to: https://localhost:8443
Registered: https://openbis.example.com Registered: https://openbis.example.com
Successfully connected to: https://openbis.example.com
``` ```
**Congratulations!** You can retry non-successful connections later, directly from the GUI. **Congratulations!** You can retry non-successful connections later, directly from the GUI. Copy the the URL given in the output and paste it in your browser. You might also just start Jupyter without the `--no-browser` option.
## Uninstall Jupyter extension ## Uninstall Jupyter extension
``` ```
jupyter serverextension disable --py jupyter-openbis-extension $ jupyter serverextension disable --py jupyter-openbis-extension
jupyter nbextension disable --py jupyter-openbis-extension --user $ jupyter nbextension disable --py jupyter-openbis-extension --user
jupyter nbextension uninstall --py jupyter-openbis-extension --user $ jupyter nbextension uninstall --py jupyter-openbis-extension --user
``` ```
This should remove the registrations in the paths listed by the This should remove the registrations in the paths listed by the
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment