数字网状化学生态系统
项目描述
简化金属-有机框架（MOFs）的特征化！此包建立在matminer的强大功能之上，使MOFs的特征化尽可能简单。现在，您可以像使用所有其他matminer特征化工具一样使用主要用于多孔材料的特征。mofdscribe还包括有助于模型验证的程序。
💪 入门
from mofdscribe.featurizers.chemistry import RACS
from pymatgen.core import Structure
structure = Structure.from_file(<my_cif.cif>)
featurizer = RACS()
racs_features = featurizer.featurize(structure)
🚀 安装
虽然我们正在努力使mofdscribe在所有操作系统上工作（我们正在等待conda recipies合并），但目前对Windows的支持不太容易（ARM架构的Mac可能存在潜在问题）。因此，我们建议在UNIX机器上安装mofdscribe。
要开发模式安装，请使用以下命令
git clone git+https://github.com/kjappelbaum/mofdscribe.git
cd mofdscribe
pip install -e .
如果您想使用所有实用工具，您可以使用all额外： pip install -e ".[all]"
我们依赖于许多其他外部工具。如果您通过conda安装mofdscribe，大多数外部工具将自动安装
conda install -c conda-forge mofdscribe
👐 贡献
贡献，无论是提交问题、创建拉取请求还是分支，都受到欢迎。有关如何参与的更多信息，请参阅CONTRIBUTING.rst。
👋 知识产权归属
⚖️ 许可证
本软件包中的代码遵循MIT许可证。
📖 引用
参阅ChemRxiv预印本。
@article{Jablonka_2022,
doi = {10.26434/chemrxiv-2022-4g7rx},
url = {https://doi.org/10.26434%2Fchemrxiv-2022-4g7rx},
year = 2022,
month = {sep},
publisher = {American Chemical Society ({ACS})},
author = {Kevin Maik Jablonka and Andrew S. Rosen and Aditi S. Krishnapriyan and Berend Smit},
title = {An ecosystem for digital reticular chemistry}
}
💰 资金来源
本研究得到欧洲研究委员会（ERC）在欧盟“地平线2020”研究和创新计划下的支持（协议号666983，MaGic），由NCCR-MARVEL提供资金，并由瑞士国家科学基金会（SNSF）在项目200021_172759下资助。
🍪 Cookiecutter
本软件包使用@audreyfeldroy的cookiecutter软件包和@cthoyt的cookiecutter-snekpack模板创建。
🛠️ 开发者指南
参阅开发者说明
README的最后一部分是关于如果你想通过代码贡献来参与的。
❓ 测试
在克隆存储库并使用pip install tox安装tox后，可以使用以下命令在tests/文件夹中可重复地运行单元测试：
tox
此外，这些测试在每次提交时都会自动在GitHub操作中重新运行。
📦 发布新版本
在开发模式下安装软件包并使用pip install tox安装tox后，创建新版本的命令包含在tox.ini中的finish环境中。在shell中运行以下命令：
tox -e finish
此脚本执行以下操作：
- 使用BumpVersion将
setup.cfg和src/mofdscribe/version.py中的版本号切换为不带-dev后缀 - 将代码打包成tar归档和wheel格式
- 使用
twine上传到PyPI。确保已配置.pypirc文件以避免在此步骤中手动输入 - 推送到GitHub。您需要创建一个与版本提升的提交相对应的发布
- 将版本提升到下一个补丁级别。如果您进行了重大更改并希望通过次要版本提升版本，可以在之后使用
tox -e bumpversion minor
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。