用于4DN争吵的脚本和Jupyter笔记本
dcicwrangling的Python项目详细描述
DCIC争论
这是一个脚本和Jupyter笔记本的集合,它们在执行许多数据争用任务时非常有用。大多数工具都是针对4DN核小体争论的需要而设计的,但是可能会被修改为对某些任务更普遍有用。在
安装
使用poetry
打包可以使用make
、poetry
或{
从dcicwrangling目录-make build
如果您已经安装了诗歌-poetry install
或者从PyPi-pip install dcicwrangling
进行pip安装
默认情况下会安装所有依赖项-如果出于某种原因您不想安装pytest
软件包或invoke
(用于启动笔记本电脑),您可以poetry install --no-dev
-不推荐。在
使用
Jupyter笔记本电脑
在notebooks/useful_notebooks
目录中有一组常用的jupyter笔记本。您可以使用顶层目录中的invoke notebook
在本地启动jupyter笔记本服务器。这将启动服务器并打开一个可以访问笔记本的浏览器页面。在
重要!-您应该在notebooks
目录中创建自己的文件夹,名为Yourname_scripts
。此文件夹是您创建、访问和运行笔记本的地方。如果要从“有用的”笔记本目录中的一个笔记本开始,请创建一个副本并将其移动到您自己的文件夹中。这样可以保持存储库的整洁和组织。请不要在有用的笔记本目录中运行笔记本,并将结果提交到存储库。在
脚本
scripts目录包含一些有用的命令行脚本。可以使用python scripts/script_name --options
从顶层目录运行它们。使用--help
显示可用选项。一般来说,修改后的版本和定制的脚本不应该提交到存储库中,或者提交给一个单独的非主分支。在
随着脚本的开发和完善,可以添加tool.poetry.scripts
指令以方便脚本的使用-请参阅pyproject.toml
文件示例。在
- 项目
标签: