# dicom2niix-webui
The web UI for dcm2niix (DICOM to NIfTI converter)
## 描述(Description)
- 功能：利用 [dcm2niix](https://github.com/rordenlab/dcm2niix) 将 **dicom** 文件转为 **nii** 文件
- 可视化：使用 [Gradio](https://github.com/gradio-app/gradio) 将该功能可视化，分为本地端使用和通用端使用方式
## 安装(Install)
- 新建一个虚拟环境(Python 3.9.16)，或使用已有的Python环境
- 例如 `$ conda create -n env_name python=3.9`
- 使用 PIP 方式安装
- `$ pip install dcm2niix-webui`
- 使用源码方式安装
- 下载本项目代码
- 点击[本项目GitHub页面](https://github.com/AlionSSS/dcm2niix-webui)右上角的绿色的按钮`Code`，再点击`Download ZIP`
- 解压项目，进入到项目根目录
- 安装，执行 `$ pip install -e ./ -i "https://pypi.doubanio.com/simple/"`
- 注
- dcm2niix 库的当前版本为 1.0.20220715
- 卸载命令 `$ pip uninstall dcm2niix-webui`
## 启动服务(Start Service)
### 直接启动
- 由于安装时已经在当前 Python 环境中安装了 script
- 所以可以在任意位置直接执行 `$ dcm2niix-gui`，启动 WebUI
### 使用代码启动
- 进入到本项目的目录下，执行 `$ cd src/dcm2niix_webui`
- 二选一
- 在本地电脑端启动，直接执行 `$ python main.py`
- 在服务器端启动，执行 `$ nohup python main.py 1>server_run.log 2>&1 &`
## 操作说明(Operating Instructions)
### 本地端(For Local)
- 在本地电脑端启动时使用（打开浏览器，访问 http://localhost:7860 ）
- 说明：填入 dicom 文件目录路径、nii 文件保存路径，点击【开始转换】即可
### 通用端(For Universal)
- 在本地电脑端、服务器端启动时皆可使用。
- 在服务端部署后，可供多人在线使用。（打开浏览器，访问 http://服务器IP:7860）
- 说明：上传 dicom 文件目录的压缩包（必填，例如 'dicom.zip'），点击【开始转换】即可
## 手动构建(Build)
- 更新、安装工具
- `$ pip install --upgrade setuptools`
- `$ pip install --upgrade build`
- 进入到项目根目录下，执行 `$ python -m build`
- 构建完成会在项目 dist 目录下，生成 tar.gz 和 whl 文件
- 直接使用 PIP 即可安装，如 `pip install .\dist\dcm2niix_webui-0.1.0-py3-none-any.whl`
Raw data
{
"_id": null,
"home_page": null,
"name": "dcm2niix-webui",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "dcm2niix, ui, webui, medicine, dicom, dcm, nii, research",
"author": null,
"author_email": "Lion A <alionsss@foxmail.com>",
"download_url": "https://files.pythonhosted.org/packages/27/6b/5bade3d1dc226c6f856e25eef83a7086dbd3dedb63ec132dd9dab934c5cb/dcm2niix_webui-0.1.2.tar.gz",
"platform": null,
"description": "# dicom2niix-webui\r\n\r\nThe web UI for dcm2niix (DICOM to NIfTI converter)\r\n\r\n## \u63cf\u8ff0(Description)\r\n\r\n- \u529f\u80fd\uff1a\u5229\u7528 [dcm2niix](https://github.com/rordenlab/dcm2niix) \u5c06 **dicom** \u6587\u4ef6\u8f6c\u4e3a **nii** \u6587\u4ef6\r\n- \u53ef\u89c6\u5316\uff1a\u4f7f\u7528 [Gradio](https://github.com/gradio-app/gradio) \u5c06\u8be5\u529f\u80fd\u53ef\u89c6\u5316\uff0c\u5206\u4e3a\u672c\u5730\u7aef\u4f7f\u7528\u548c\u901a\u7528\u7aef\u4f7f\u7528\u65b9\u5f0f\r\n\r\n## \u5b89\u88c5(Install)\r\n- \u65b0\u5efa\u4e00\u4e2a\u865a\u62df\u73af\u5883(Python 3.9.16)\uff0c\u6216\u4f7f\u7528\u5df2\u6709\u7684Python\u73af\u5883\r\n - \u4f8b\u5982 `$ conda create -n env_name python=3.9`\r\n- \u4f7f\u7528 PIP \u65b9\u5f0f\u5b89\u88c5\r\n - `$ pip install dcm2niix-webui`\r\n- \u4f7f\u7528\u6e90\u7801\u65b9\u5f0f\u5b89\u88c5\r\n - \u4e0b\u8f7d\u672c\u9879\u76ee\u4ee3\u7801\r\n - \u70b9\u51fb[\u672c\u9879\u76eeGitHub\u9875\u9762](https://github.com/AlionSSS/dcm2niix-webui)\u53f3\u4e0a\u89d2\u7684\u7eff\u8272\u7684\u6309\u94ae`Code`\uff0c\u518d\u70b9\u51fb`Download ZIP`\r\n - \u89e3\u538b\u9879\u76ee\uff0c\u8fdb\u5165\u5230\u9879\u76ee\u6839\u76ee\u5f55\r\n - \u5b89\u88c5\uff0c\u6267\u884c `$ pip install -e ./ -i \"https://pypi.doubanio.com/simple/\"`\r\n- \u6ce8\r\n - dcm2niix \u5e93\u7684\u5f53\u524d\u7248\u672c\u4e3a 1.0.20220715\r\n - \u5378\u8f7d\u547d\u4ee4 `$ pip uninstall dcm2niix-webui`\r\n\r\n## \u542f\u52a8\u670d\u52a1(Start Service)\r\n### \u76f4\u63a5\u542f\u52a8\r\n- \u7531\u4e8e\u5b89\u88c5\u65f6\u5df2\u7ecf\u5728\u5f53\u524d Python \u73af\u5883\u4e2d\u5b89\u88c5\u4e86 script\r\n- \u6240\u4ee5\u53ef\u4ee5\u5728\u4efb\u610f\u4f4d\u7f6e\u76f4\u63a5\u6267\u884c `$ dcm2niix-gui`\uff0c\u542f\u52a8 WebUI\r\n\r\n### \u4f7f\u7528\u4ee3\u7801\u542f\u52a8\r\n- \u8fdb\u5165\u5230\u672c\u9879\u76ee\u7684\u76ee\u5f55\u4e0b\uff0c\u6267\u884c `$ cd src/dcm2niix_webui`\r\n- \u4e8c\u9009\u4e00\r\n - \u5728\u672c\u5730\u7535\u8111\u7aef\u542f\u52a8\uff0c\u76f4\u63a5\u6267\u884c `$ python main.py`\r\n - \u5728\u670d\u52a1\u5668\u7aef\u542f\u52a8\uff0c\u6267\u884c `$ nohup python main.py 1>server_run.log 2>&1 &`\r\n\r\n## \u64cd\u4f5c\u8bf4\u660e(Operating Instructions)\r\n### \u672c\u5730\u7aef(For Local)\r\n- \u5728\u672c\u5730\u7535\u8111\u7aef\u542f\u52a8\u65f6\u4f7f\u7528\uff08\u6253\u5f00\u6d4f\u89c8\u5668\uff0c\u8bbf\u95ee http://localhost:7860 \uff09\r\n- \u8bf4\u660e\uff1a\u586b\u5165 dicom \u6587\u4ef6\u76ee\u5f55\u8def\u5f84\u3001nii \u6587\u4ef6\u4fdd\u5b58\u8def\u5f84\uff0c\u70b9\u51fb\u3010\u5f00\u59cb\u8f6c\u6362\u3011\u5373\u53ef\r\n\r\n\r\n\r\n\r\n### \u901a\u7528\u7aef(For Universal)\r\n- \u5728\u672c\u5730\u7535\u8111\u7aef\u3001\u670d\u52a1\u5668\u7aef\u542f\u52a8\u65f6\u7686\u53ef\u4f7f\u7528\u3002\r\n- \u5728\u670d\u52a1\u7aef\u90e8\u7f72\u540e\uff0c\u53ef\u4f9b\u591a\u4eba\u5728\u7ebf\u4f7f\u7528\u3002\uff08\u6253\u5f00\u6d4f\u89c8\u5668\uff0c\u8bbf\u95ee http://\u670d\u52a1\u5668IP:7860\uff09\r\n- \u8bf4\u660e\uff1a\u4e0a\u4f20 dicom \u6587\u4ef6\u76ee\u5f55\u7684\u538b\u7f29\u5305\uff08\u5fc5\u586b\uff0c\u4f8b\u5982 'dicom.zip'\uff09\uff0c\u70b9\u51fb\u3010\u5f00\u59cb\u8f6c\u6362\u3011\u5373\u53ef\r\n\r\n\r\n\r\n## \u624b\u52a8\u6784\u5efa(Build)\r\n- \u66f4\u65b0\u3001\u5b89\u88c5\u5de5\u5177\r\n - `$ pip install --upgrade setuptools`\r\n - `$ pip install --upgrade build`\r\n- \u8fdb\u5165\u5230\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\uff0c\u6267\u884c `$ python -m build`\r\n- \u6784\u5efa\u5b8c\u6210\u4f1a\u5728\u9879\u76ee dist \u76ee\u5f55\u4e0b\uff0c\u751f\u6210 tar.gz \u548c whl \u6587\u4ef6\r\n- \u76f4\u63a5\u4f7f\u7528 PIP \u5373\u53ef\u5b89\u88c5\uff0c\u5982 `pip install .\\dist\\dcm2niix_webui-0.1.0-py3-none-any.whl`\r\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: Apache Software License",
"summary": "The web UI for dcm2niix (DICOM to NIfTI converter)",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/AlionSSS/dcm2niix-webui",
"Repository": "https://github.com/AlionSSS/dcm2niix-webui.git"
},
"split_keywords": [
"dcm2niix",
" ui",
" webui",
" medicine",
" dicom",
" dcm",
" nii",
" research"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2aeeb97d1a35232e9161f40940fa6b08b38b96822dec716cbed5c6f952b88952",
"md5": "57aa099c6e5906911b6b4e550c53dc05",
"sha256": "1be933198a76d4917e0a67d824e2bd56be47a59506c3aa3ed067a2da1ddf70c1"
},
"downloads": -1,
"filename": "dcm2niix_webui-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57aa099c6e5906911b6b4e550c53dc05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 69627,
"upload_time": "2024-07-27T11:24:18",
"upload_time_iso_8601": "2024-07-27T11:24:18.659740Z",
"url": "https://files.pythonhosted.org/packages/2a/ee/b97d1a35232e9161f40940fa6b08b38b96822dec716cbed5c6f952b88952/dcm2niix_webui-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "276b5bade3d1dc226c6f856e25eef83a7086dbd3dedb63ec132dd9dab934c5cb",
"md5": "6d10105051786491b1ce9e595abfe17b",
"sha256": "1f85872c50b9e9b520b5ce46b85f575ee1bc82a6d18e2782f995ba1c604978f0"
},
"downloads": -1,
"filename": "dcm2niix_webui-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "6d10105051786491b1ce9e595abfe17b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 71291,
"upload_time": "2024-07-27T11:24:20",
"upload_time_iso_8601": "2024-07-27T11:24:20.534893Z",
"url": "https://files.pythonhosted.org/packages/27/6b/5bade3d1dc226c6f856e25eef83a7086dbd3dedb63ec132dd9dab934c5cb/dcm2niix_webui-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-27 11:24:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AlionSSS",
"github_project": "dcm2niix-webui",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dcm2niix-webui"
}
JSON
