jupyter笔记本连接openbis和下载/上传数据集的扩展,包括笔记本本身
jupyter-openbis-extension的Python项目详细描述
jupyter openbis扩展
要求
jupyter openbis扩展至少需要python 3.3才能运行。jupyter笔记本服务器在启动期间启动此扩展,因此必须在相同的python版本下运行。内核可以是任何东西(python 2.7、julia、r、perl…)
此扩展已经在Safari 12.0.3、Chrome 72.0和Firefox 66.0上成功测试。在firefox 61.0b13之前有一个已知的不兼容。
安装加长件
如果您还没有完成:从pip下载最新的jupyter openbis扩展。它将自动安装各种依赖项,例如pandas和numpy。
pip install --upgrade jupyter-openbis-extension
创建配置文件
这一步并不十分必要,因为您可以在jupyter笔记本中定义openbis连接。但是,如果您需要多次连接到同一个openbis连接,这将变得很方便。
创建文件openbis-connections.yaml
。它应该包含到服务器的连接信息,例如:
connections:
- name : TEST local openBIS instance
url : https://localhost:8443
verify_certificates : false
username : username
password : password
- name : PRODUCTION openBIS instance
url : https://openbis.example.com
verify_certificates : true
username : username
note 1:您不需要用户名和密码。使用当前版本,您可以直接从jupyter笔记本中输入用户名和密码。
注意2:将此文件放在这些目录中的任何一个(在Mac OS X上):
/Users/your_username/jupyter-openbis-extension/notebooks
/Users/your_username/.jupyter
/Users/your_username/.pyenv/versions/3.6.0/etc/jupyter # or wherever your jupyter installation is located
/usr/local/etc/jupyter
/etc/jupyter
这些目录可以通过调用
$ jupyter --paths
输出中的config
部分列出了放置openbis-connections.yaml
文件的目录。
手动安装Jupyter扩展插件
在大多数情况下,一个简单的pip install --upgrade jupyter-openbis-extension
就可以了。但是,在某些情况下,您需要发出以下命令才能使扩展正常运行:
$ jupyter serverextension enable --py jupyter-openbis-extension
$ jupyter nbextension install --py jupyter-openbis-extension --user
$ jupyter nbextension enable --py jupyter-openbis-extension --user
如果要全局安装扩展,请使用--system
,而不是--user
。
启动Jupyter笔记本
现在您可以启动Jupyter笔记本了:
$ jupyter notebook --no-browser
观察端子。它应该告诉您哪些服务器已经注册。如果您提供了密码,它将尝试连接:
$ jupyter notebook
Registered: https://localhost:8443
Successfully connected to: https://localhost:8443
Registered: https://openbis.example.com
恭喜!您可以稍后直接从图形用户界面重试不成功的连接。复制输出中给定的url并将其粘贴到浏览器中。您也可以在没有--no-browser
选项的情况下启动jupyter。
卸载jupyter扩展
$ jupyter serverextension disable --py jupyter-openbis-extension
$ jupyter nbextension disable --py jupyter-openbis-extension --user
$ jupyter nbextension uninstall --py jupyter-openbis-extension --user
这将删除
$ jupyter --paths
命令。
流浪者的发展
如果要使用预定义的开发环境,请执行以下步骤:
安装最新版本的virtualbox(https://www.virtualbox.org)
安装最新版本的vagrant(https://www.vagrantup.com/downloads.html)
vagrant plugin安装vagrant vbguest vagrant notify forwarder vagrant disksize
CD流浪者
向上游荡
设置完成后,您将拥有
- 在http://localhost:8888运行openbis扩展的jupyter。
- openbis运行于https://localhost:8122/openbis/,具有管理员/密码凭据。
- object/default/default,包含大量测试数据集。
提示:jupyter不创建日志文件。所有的东西都印在控制台上。要查看此输出,请执行以下操作:
- 游民宋承宪
- 屏幕-r
您可以键入“^a”然后键入“^d”从屏幕中退出。
克隆存储库并安装扩展以进行开发
$ 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 .
-e
是--editable
的快捷方式。这意味着,它将只建立到源文件夹的链接,而不是复制文件。对jupyter服务器扩展名(python文件)进行任何修改时,需要重新启动jupyter notebook才能看到更改。
如果对ui(javascript文件)进行修改,只需重新加载页面即可看到效果。
介绍了如何扩展jupyter笔记本。分发朱庇特分机离子,仔细阅读这篇documentation。