处理结构图的实用工具
项目描述
structuregraph_helpers
处理pymatgen
结构图的实用工具。
💪 入门指南
import structuregraph_helpers as sgh
mols, graphs, indices, centers, coordinates = sgh.subgraphg.get_subgraphs_as_molecules(structuregraph)
graph_hash = sgh.hash.decorated_graph_hash(structuregraph)
scaffold_hash = sgh.hash.decorated_scaffold_hash(structuregraph)
🚀 安装
可以从PyPI安装最新版本:
$ pip install structuregraph_helpers
可以直接从GitHub使用以下命令安装最新代码和数据:
$ pip install git+https://github.com/kjappelbaum/structuregraph-helpers.git
要开发模式下安装,请使用以下命令:
$ git clone git+https://github.com/kjappelbaum/structuregraph-helpers.git
$ cd structuregraph-helpers
$ pip install -e .
👐 贡献
贡献,无论是提交问题、提交拉取请求还是分支,都受到欢迎。有关如何参与的更多信息,请参阅CONTRIBUTING.rst。
👋 属性
⚖️ 许可证
本包中的代码根据MIT许可证授权。
🍪 Cookiecutter
本包是用@audreyfeldroy的cookiecutter包以及使用@cthoyt的cookiecutter-snekpack模板创建的。
🛠️ 开发者
请参阅开发者指南
README的最后一部分是为了如果您想通过代码贡献来参与。
❓ 测试
在克隆仓库并使用 pip install tox
安装 tox
后,可以重复运行 tests/
文件夹中的单元测试。
$ tox
此外,这些测试在每次提交到 GitHub Action 时都会自动重新运行。
📦 制作发行版
在开发模式下安装包并使用 pip install tox
安装 tox
后,在 tox.ini
中的 finish
环境中包含了创建新发行版的命令。请在 shell 中运行以下命令
$ tox -e finish
此脚本执行以下操作
- 使用 BumpVersion 将
setup.cfg
和src/structuregraph_helpers/version.py
中的版本号切换,使其不包含-dev
后缀 - 将代码打包成 tar 归档和 wheel 格式
- 使用
twine
上传到 PyPI。请确保已配置.pypirc
文件以避免在此步骤中需要手动输入 - 推送到 GitHub。您需要创建一个与版本提升提交相对应的发行版。
- 将版本提升到下一个补丁版本。如果您进行了重大更改并希望通过次要版本提升版本,则可以在之后使用
tox -e bumpversion minor
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。
源分发
structuregraph_helpers-0.0.9.tar.gz (94.8 kB 查看哈希值)
构建分发
关闭
结构图辅助工具-0.0.9.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | b7e05a080c832c53fc7d48f8a91653c95ec4ea79e5e199dc6d2e3adb6a6eb644 |
|
MD5 | d3c8ddc12c54ebe3f0d3a9db47f8bdc8 |
|
BLAKE2b-256 | 7841b5fd49d4c5dcdb944d84b7a25f57d7f66ec0e591233d97192e5f9d7d0250 |
关闭
结构图辅助工具-0.0.9-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 6e872f8b6d0ca0ab8c9f3ae52b2014947f6f2f2d94527619ac9bc7173de21b60 |
|
MD5 | b10969ae0a8d595f6a3b94a127e8ac03 |
|
BLAKE2b-256 | ab7cd74f36987288388272d92740f3895e831350a0d2939bd12b3a112265c57a |