OpenNeuro的Python客户端。
项目描述
openneuro-py
用于访问OpenNeuro数据集的Python客户端。
安装
# via conda:
conda install -c conda-forge openneuro-py
# or via pip:
pip install openneuro-py
Jupyter和IPython支持
为了获得对Jupyter Lab、Jupyter Notebook、IPython交互会话和VS Code交互式Jupyter界面的基本支持,您还需要安装ipywidgets
# via conda:
conda install -c conda-forge ipywidgets
# or via pip:
pip install ipywidgets
基本用法 - 命令行界面
获取帮助
openneuro-py --help
openneuro-py download --help
openneuro-py login --help
下载整个数据集
openneuro-py download --dataset=ds000246
指定目标目录
要将在特定目录中存储下载的文件,请使用--target_dir
开关。如果该目录不存在,则将创建该目录。
openneuro-py download --dataset=ds000246 \
--target_dir=data/bids
继续中断的下载
中断的下载将在您再次运行命令时从上次中断的地方继续。
高级用法 - 命令行界面
排除目录下载
openneuro-py download --dataset=ds000246 \
--exclude=sub-emptyroom
仅下载单个文件
openneuro-py download --dataset=ds000246 \
--include=sub-0001/meg/sub-0001_coordsystem.json
请注意,一些必要的BIDS文件将始终作为附加下载。
下载或排除多个文件
--include
和--exclude
可以多次传递
openneuro-py download --dataset=ds000246 \
--include=sub-0001/meg/sub-0001_coordsystem.json \
--include=sub-0001/meg/sub-0001_acq-LPA_photo.jpg
使用API令牌登录
要下载私有数据集,您需要一个提供访问权限的API密钥。请访问OpenNeuro.org,我的账户 → 获取API密钥。复制密钥,然后运行
openneuro-py login
粘贴API密钥并按回车键。
基本用法 - Python接口
import openneuro as on
on.download(dataset='ds000246', target_dir='data/bids')