Python的一个简单、健壮且灵活的即时(JIT)作业管理框架。
项目描述
Custodian是一个用Python编写的简单、健壮且灵活的即时(JIT)作业管理框架。使用custodian,您可以创建执行错误检查、作业管理和错误恢复的包装器。它有一个简单的插件框架,允许您为不同的应用程序开发特定的作业管理工作流程。
错误恢复是许多大规模生成数据的高通量项目的一个重要方面。当您运行成千上万的作业时,即使1%的错误率也会意味着数千个错误的作业,这些作业将无法逐个处理。
托管的具体用途是为长时间运行的任务,可能存在随机错误。例如,可能有一个脚本在服务器上运行需要几天时间,有1%的概率出现某些I/O错误导致任务失败。使用托管,可以开发出从错误中优雅恢复的机制,如果需要,可以修改参数后重新启动任务。
Custodian的当前版本还附带几个用于处理Vienna Ab Initio Simulation Package (VASP)、NwChem、QChem、FEFF、Lobster和CP2K计算的错误处理的子包。
获取Custodian
稳定版本
Python包索引(PyPI)上的版本始终是最新稳定发布版本,希望相对无错误。安装方法如下
pip install custodian
某些插件(例如,VASP管理)需要额外的设置(请参阅pymatgen文档)。
开发版本
前沿的开发版本位于Custodian的Github仓库。开发版本可能包含更多错误,但可能包含新功能。Github版本还包括测试文件,以进行完整的单元测试。克隆源代码后,您可以输入
pip install -e .
或以开发模式安装包:
python setup.py develop
需求
Custodian支持Python 3.8+。没有其他必需的依赖项。但是,如果您想使用许多内置的错误处理程序和VASP、NWChem、QChem等任务,您可能还需要安装pymatgen。
用法
有关如何使用Custodian的详细信息,请参阅官方Custodian文档。
如何引用Custodian
如果您在研究中使用了Custodian,特别是VASP组件,请考虑引用以下工作
Shyue Ping Ong, William Davidson Richards, Anubhav Jain, Geoffroy Hautier,
Michael Kocher, Shreyas Cholia, Dan Gunter, Vincent Chevrier, Kristin A.
Persson, Gerbrand Ceder. *Python Materials Genomics (pymatgen) : A Robust,
Open-Source Python Library for Materials Analysis.* Computational
Materials Science, 2013, 68, 314-319. doi:10.1016/j.commatsci.2012.10.028
许可证
Custodian采用MIT许可证发布。许可证条款如下
The MIT License (MIT)
Copyright (c) 2011-2012 MIT & LBNL
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分发
构建分发
custodian-2024.6.24.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | e94530e7c9839706d280be68cc49e0035e620eb2f0bc792a8ba5fe793159ae41 |
|
MD5 | 982a8f35cbc4df4590d1c592512723a4 |
|
BLAKE2b-256 | ef153f99639f7c772f6d5470da2e196fa2bfdad4a8168b5901f0fe11f1c7f30f |
custodian-2024.6.24-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 5507a08902d1332af592654b73151ba59780c012df98df022f1896e9cb3de167 |
|
MD5 | 37d554890e22ad31b6098f8f72eb589c |
|
BLAKE2b-256 | 4015b84b2fc90a78589add7913d8b2893f516acc437627d89c8d337fafe406f3 |