跳转到主要内容

AiiDA插件用于LAMMPS代码

项目描述

CI Status Coverage Status PyPI Code style: black Docs status

AiiDA LAMMPS插件

这是一个用于经典分子动力学代码LAMMPSAiiDA插件。

此插件包含两种类型的计算

  • lammps.base:使用基于参数的输入生成进行单阶段LAMMPS计算的计算。
  • lammps.raw:使用预制的LAMMPS输入文件的计算。

lammps.base还用于处理三种工作流程

安装

从PyPI安装稳定版本

pip install aiida-lammps

从源代码安装

git clone https://github.com/aiidaplugins/aiida-lammps.git
pip install -e aiida-lammps

内置势支持

lammps.base计算和相关工作流程使用由通过传递势文件和一些标签参数创建的LammpsPotentialData数据结构。

此数据结构可以用来处理以下潜在类型

  • 单个文件势:可以存储在单个文件中的任何势,例如 EAMMEAMTersoffReaxFF
  • 直接参数化的势:其参数通过输入文件中的 pair_coeff 直接给出的势,例如 BornLennard-JonesYukawa。这些参数应写入一个文件,然后存储到 LammpsPotentialData 节点中。

示例

更多示例计算可以在 /examples 文件夹以及文档中找到。这些示例涉及使用 LAMMPS 进行单阶段计算的一些常见情况。

开发

运行测试

可以使用 tox 在隔离的虚拟环境中运行测试套件(参见仓库中的 tox.ini

pip install tox
tox -e 3.9-aiida_lammps -- tests/

或直接

pip install .[testing]
pytest -v

测试需要 PostgreSQL 和 RabbitMQ 都正在运行。如果您想运行隔离的 RabbitMQ 实例,请参阅仓库中的 docker-compose.yml 文件。

一些测试需要存在一个 lammps 可执行文件。

实现此目标的最简单方法是使用 Conda

conda install lammps==2019.06.05
# this will install lmp_serial and lmp_mpi

您可以使用以下命令为 LAMMPS 指定不同的可执行文件名

tox -e 3.9-aiida_lammps -- --lammps-exec lmp_exec

将 calcjob 执行的结果输出到特定目录

pytest --lammps-workdir "test_workdir"

提交前

代码使用 pre-commit 格式化和检查,以确保代码符合标准

cd aiida-lammps
pre-commit run --all

或自动化运行,在每次提交之前触发

pre-commit install

许可证

aiida-lammps 插件包在 MIT 许可下发布。有关详细信息,请参阅 LICENSE 文件。

项目详情


下载文件

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

源分发

aiida_lammps-1.0.2.tar.gz (308.7 kB 查看哈希)

上传时间

构建分发

aiida_lammps-1.0.2-py3-none-any.whl (60.1 kB 查看哈希)

上传时间 Python 3

支持者:

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