计算结构生物学工具箱
csb的Python项目详细描述
csb是一个python库和应用程序框架,可以使用 解决结构生物信息学领域的问题。如果 你是生物信息学家,软件工程师或研究人员 在这个领域,你很有可能在这里找到有用的东西。我们的 软件包由几个主要组件组成:
- 核心类库-面向对象,细粒度,强调 关于设计和干净的界面。
- 应用程序框架-控制台应用程序(“协议”), 使用核心库中的对象来构建 可执行的东西(希望有用)。
- 测试框架-确保库实际工作。
安装
csb是在linux上用python 2.7和3.6开发的。但是,兼容性 是一个设计目标,这个包可以在任何平台上,任何现代python上工作 从2.6版开始的解释器(包括 盒子)。如果您发现平台/解释器与 我们的发展环境,请告诉我们。
csb及其所有依赖项都可以使用pip安装:
$ pip install csb
有关详细信息,请参见http://csb-toolbox.github.io/Installation。
运行CSB应用程序
csb与许多可执行控制台csb.apps捆绑在一起。每个应用程序 提供标准的命令行界面。要运行任何应用程序,请尝试:
$ csb-app --help
其中csb app是应用程序的名称,例如csb-hhfrag。 有关我们的应用程序框架的更多详细信息,包括编写新的 应用程序,请参阅API文档,包“csb.apps”。
文档
项目的网站GitHub包含 在线文档和样本。访问我们:
详细的api文档可以在 分发包(docs/api/index.html)。这部纪录片也是由 在我们的网站上:
https://csb-toolbox.github.io/api-docs/
许多软件包包含介绍性的模块级文档和示例/教程。 HTML文档中也提供了这些功能,但是访问它们的快速方法是使用 内置的python帮助系统。例如,一般介绍 请参阅根包的模块文档:
$ python -c "import csb; help(csb)"
如果您对特定的包感兴趣,例如cs.bio.sequence, 尝试:
$ python -c "import csb.bio.sequence; help(csb.bio.sequence)"
许可证
CSB是开源的,并根据OSI批准的MIT许可证分发。
Copyright (c) 2012 Michael Habeck Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.