跳转到主要内容

挖掘MOF氧化态并特征化金属位点。

项目描述

oximachine_featurizer

Actions Status Documentation Status DOI Binder codecov

从CSD中(MOF)子集挖掘结构的氧化态并计算其特征。自动安装运行脚本以执行最重要的步骤。其中一些运行脚本包含硬编码的路径,需要更新。此代码生成可用于与learnmofox包一起使用以复制我们工作的输入[1]。

如果您只是对使用预训练模型感兴趣,请使用oximachinerunner包

⚠️ 警告:对于氧化态的挖掘,您需要CSD Python API。您需要导出CSD_HOME路径。由于许可问题,这不能自动完成。

安装

以下命令将自动安装几个命令行工具(CLI),详情如下。

整个过程可能需要几秒钟。

最新版本

要使用所有依赖项安装软件的最新版本,可以使用

pip install git+https://github.com/kjappelbaum/oximachine_featurizer.git

稳定版本

pip install oximachine_featurizer

如何使用

要在一个结构上运行默认的特征化,可以使用CLI

run_featurization <structure> <outdir>

对于每个金属中心,如果没有混乱,这应该只需要几秒钟。

一些输出可以在MaterialsCloud存档(doi: 10.24435/materialscloud:2019.0085/v1)中找到。

更多详细信息请参阅文档

示例用法

本包主要功能的用法在示例目录中的Jupyter Notebook中展示。它包含一些示例结构和输出,这些输出应在几秒内产生。

测试安装

为了测试,你可以——就像用于持续集成(CI)那样——使用pytest并运行test目录中的文件。例如

pip install pytest
pytest test/main

参考文献

[1] Jablonka, Kevin Maik; Ongari, Daniele; Moosavi, Seyed Mohamad; Smit, Berend (2020): Using Collective Knowledge to Assign Oxidation States. ChemRxiv. 预印本. https://doi.org/10.26434/chemrxiv.11604129.v1

项目详情


下载文件

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

源代码分布

oximachine_featurizer-0.4.0.tar.gz (49.8 kB 查看哈希值)

上传时间 源代码

构建分布

oximachine_featurizer-0.4.0-py3-none-any.whl (52.5 kB 查看哈希值)

上传时间 Python 3

支持者

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