方便性和包装函数的集合,支持科学家经常需要的任务
sci的Python项目详细描述
python 3包,或者简单地说是支持任务的便利性和包装函数的集合 科学家经常需要的。
安装
pip3 install sci或
pip3 install --user--upgrade sci
在没有根访问权限的共享计算机上使用--user标志。它将安装 在~/.local/lib/python3.x/site-packages/sci这样的地方打包。你可以删除那个文件夹 稍后删除包。
设计目标
- 简单性:将经常使用的工作流包装成简单的函数,使 科学家。大多数import语句都应该移到函数中(除了常用的 像os,sys)一样,在自动完成vs代码和其他ide时避免混淆。
- 冗长但易于使用的docstrings:docstrings可以通过ide中的代码自动完成来访问 例如vs代码或atom以及sphinx等自动化文档环境。每个 docsting应该从函数的示例用例开始。
- 函数式编程范例:虽然允许使用类,但我们鼓励减少编写 类和更多函数(可能有decorators)
- 跨平台:代码应该在Linux(基于RHEL和Debian)、Windows和MacOSX上工作。
- 只支持python 3的兼容性,python 2.x是遗留的,我们不想在 它。
如何贡献自己的代码
- git clone git@github.com:FredHutch/sci-pkg.git
- 创建新分支(例如:sci yourname)
- 将函数粘贴到模块sci/new.py中。
- 确保在文档字符串的第一行中添加了一个示例调用。
- 将测试用例添加到sci pkg/sci/tests中