我们的使命¶
SCRICIT-IMAGE的目标是成为在Python中进行科学图像分析的参考库。我们通过以下方式实现这一目标:
存在 易于使用和安装 。我们在接受新的依赖项时非常谨慎,有时会剔除现有的依赖项,或者将其设置为可选的。我们的API中的所有函数都有详细的文档字符串,以阐明预期的输入和输出。
提供一个 一致的API 。概念上相同的参数在函数签名中具有相同的名称和位置。
确保正确性 。测试覆盖率接近100%,代码在被包含在库中之前至少要经过两名核心开发人员的审查。
关心用户数据 。我们有一个 [函数式API] [功能] 除非明确指示,否则不要修改输入数组。
推介 图像处理教育 ,并附有丰富的教学文献。
我们的价值观¶
我们是包容的。我们继续欢迎和指导做出第一次贡献的新来者。
我们是社区驱动的。关于API和功能的决定是由我们用户的需求驱动的,而不是核心团队的突发奇想。(参见治国。)
我们主要服务于科学应用程序,在Photoshop或GIMP的脉络中进行“消费者”图像编辑。这通常意味着优先考虑对n维数据的支持,并拒绝实施几乎没有科学价值的“华而不实”的过滤器。
我们看重简单、可读的实现,而不是获得每一分每一秒的性能。对于新手和维护者来说,易于理解的易读代码使贡献新代码以及防止错误变得更容易。例如,这意味着,如果代码行数减少两倍,我们更愿意将速度降低20%。
我们重视教育和文件记录。所有函数都应具有NumPy样式 [文档字符串] [数字多克] 最好是举例,以及展示该函数如何在科学应用中使用的图库例子。核心开发人员在完成文档示例方面发挥了积极作用。
我们不会变魔术。我们使用NumPy数组而不是花哨的外墙对象 [^np] ,我们更愿意教育用户,而不是代表他们做出决定。这并不排除 [合理的默认设置] [默认值] 。
本文档¶
这很像是 [ Python 的禅宗] [zen] 和PEP8指南风格和实现细节在大多数Python代码中,本指南旨在指导有关SCRICKIT-IMAGE未来的决策,无论是在代码风格方面,是否接受新功能,或者是否采取新的依赖关系,等等。
参考文献¶
要了解有关本文档历史的更多信息,请阅读以下内容:
[原创博客帖子] [blog]
[GitHub问题] [问题]
[Image.sc论坛帖子] [论坛]
[跳过GitHub拉取请求] [skip_pr]
版权所有¶
本文档专门针对具有知识共享CC0的公有领域 [许可证] [cc0] 。在适当的情况下,鼓励将此来源归于此,根据 [CC0+By] [ccby] 。
- 1
NumPy数组的使用是该声明中最受支持的组件,以及关于包容性、指导和文档的要点。我们有来自马克·哈弗什、罗伊·阿维塔尔和格雷格·李等人的+1。