diff --git a/README.md b/README.md index e9bcc25c13962ede2210be00889309c16a16626c..aae03bf42200727fc9cdb044a6c148b01867e4cf 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,19 @@ If you haven't done yet: download the latest jupyter-openbis-extension from pip. pip install --upgrade jupyter-openbis-extension ``` +or, if you would like to develop: + +``` +$ git clone git@sissource.ethz.ch:sispub/jupyter-openbis-extension.git +$ cd jupyter-openbis-extension +$ virtualenv venv +$ source venv/bin/activate +(venv) $ pip install -e . +(venv) $ jupyter serverextension enable --py jupyter-openbis-extension +(venv) $ jupyter nbextension install --py jupyter-openbis-extension --user --symlink +(venv) $ jupyter nbextension enable jupyter-openbis-extension --user --py +``` + **Register the Jupyter server extension** which will communicate both with openBIS and the notebook: ``` @@ -159,4 +172,4 @@ Known nbextensions: notebook section jupyter-openbis-extension/dialog enabled - Validating: OK -``` \ No newline at end of file +```