跳转到主要内容

处理结构图的实用工具

项目描述

structuregraph_helpers

Tests Cookiecutter template from @cthoyt PyPI PyPI - Python Version PyPI - License Documentation Status Code style: black

处理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

本包是用@audreyfeldroycookiecutter包以及使用@cthoytcookiecutter-snekpack模板创建的。

🛠️ 开发者

请参阅开发者指南

README的最后一部分是为了如果您想通过代码贡献来参与。

❓ 测试

在克隆仓库并使用 pip install tox 安装 tox 后,可以重复运行 tests/ 文件夹中的单元测试。

$ tox

此外,这些测试在每次提交到 GitHub Action 时都会自动重新运行。

📦 制作发行版

在开发模式下安装包并使用 pip install tox 安装 tox 后,在 tox.ini 中的 finish 环境中包含了创建新发行版的命令。请在 shell 中运行以下命令

$ tox -e finish

此脚本执行以下操作

  1. 使用 BumpVersion 将 setup.cfgsrc/structuregraph_helpers/version.py 中的版本号切换,使其不包含 -dev 后缀
  2. 将代码打包成 tar 归档和 wheel 格式
  3. 使用 twine 上传到 PyPI。请确保已配置 .pypirc 文件以避免在此步骤中需要手动输入
  4. 推送到 GitHub。您需要创建一个与版本提升提交相对应的发行版。
  5. 将版本提升到下一个补丁版本。如果您进行了重大更改并希望通过次要版本提升版本,则可以在之后使用 tox -e bumpversion minor

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源分发

structuregraph_helpers-0.0.9.tar.gz (94.8 kB 查看哈希值)

上传日期

构建分发

structuregraph_helpers-0.0.9-py3-none-any.whl (71.7 kB 查看哈希值)

上传日期 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面