matador-db 0.10.2

安装

在最简单的情况下（例如，您已经设置了Python 3.7+），只需pip install matador-db即可启动，最好在一个新的虚拟环境中。

升级到最新版本应该像pip install -U matador-db一样简单。

对于可编辑的开发安装，从该存储库克隆源代码，并在matador文件夹中运行pip install -e .。您可以使用python -m unittest discover -v -b在本地机器上运行测试，或者安装测试依赖项后简单地使用py.test。为了测试CASTEP运行功能，测试将查找在您的$PATH上的名为castep的启用MPI的可执行文件。

更多信息请查阅安装说明。

使用方法

matador主要是一个Python 库，可以在Python脚本/模块中使用，以创建自定义工作流程。然而，matador本身附带了一些命令行脚本。所有这些脚本都列在命令行界面使用下。

对于基本的命令行使用，请探索每个命令的帮助系统。常见的工作流程可以在examples/和在线文档中找到。

有关程序化使用，请参阅完整的Python API文档。

核心功能

API具有许多特性，可以在示例和API文档中进行探索。总结来说，matador可用于

• 从CASTEP（和Quantum Espresso）的输入/输出文件中抓取到灵活的Python字典/模型。

• 创建和管理MongoDB集合的几何优化计算，具有强大的查询CLI/API。

• 为所有模型提供可定制的、可用于发表的绘图，例如相图、PDF、PXRD、电压曲线、电子/振动能带结构等。

• 使用CASTEP（和Quantum Espresso）以及run3进行高吞吐量几何优化、电子和振动特性。已在多个超级计算机上测试。run3主要用于简单的流程，并提供少量创建复杂流程的工具；如果这是您的用例，请查看以下列出的其他代码。

• 从DFT计算的结果创建相图和电化学电压曲线。

此功能通过与其他标准科学Python堆栈（如NumPy、SciPy、matplotlib）、一些更具体的材料包（如spglib、SeeK-path、periodictable）和其他通用包（如pymongo、python-ternary、numba）接口实现。

类似包

这个包在功能和目标上绝对不是独一无二的。以下是类似包的列表以及它们与matador的交叉概述

• ASE：结构操作、解析和导出文件、运行作业和本地数据库（使用ase-db）。提供了对ASE的Atoms对象的接口。

• pymatgen：类似于ASE，专注于VASP DFT代码。提供了对pymatgen的Structure对象的接口。可以使用pymatgen-db附加组件构建本地数据库，并使用Fireworks实现高吞吐量工作流程。

• AiiDA：为许多模拟代码提供高吞吐量作业运行、来源追踪和数据库存储。

• sumo：高质量的绘图，主要用于VASP，但也支持其他代码。

如果您认为这个列表过时、不正确或只是不完整，请提出问题！

引用matador

如果您在工作中使用了matador，我们很乐意您引用以下内容：

Matthew L. Evans, Andrew J. Morris, matador：一个用于分析、整理和执行高吞吐量密度泛函理论计算的Python库，《开源软件杂志》，第5卷，第54期，2563（2020）10.21105/joss.02563

所有版本（0.9以上）的源代码存档可以在Zenodo上找到DOI 10.5281/zenodo.3908573。