1个不稳定版本

使用旧的Rust 2015

0.0.0 2016年12月13日

#29 in #computational

BSD-2-Clause

5KB

Lumol分子模拟引擎

Build Status Coverage Documentation Gitter

Lumol是一个经典分子模拟引擎,为开发新算法和方法提供了一个坚实的基础。使用Lumol,您可以自定义模拟中所有算法的行为。添加新的力场、定制Monte-Carlo移动或分子动力学积分器既简单又有良好的文档。

Lumol的目标是灵活、可靠和可扩展。对我们来说,这意味着这款软件应该是

  • 灵活的:代码可以模拟各种系统,从蛋白质到晶体,使用各种方法:分子动力学、蒙特卡罗、等等。
  • 可靠的:代码经过良好的测试,不仅在函数级别,而且在模拟级别,检查系统的热力学性质;
  • 可扩展的:代码是模块化的、面向对象的、有良好的文档、开源且易于阅读。

Lumol正在积极开发中,应被视为alpha软件。如果您感兴趣,有任何问题或想参与其中,您可以通过Github问题或访问项目的聊天室

功能

  • 配对、分子和静电相互作用(使用Ewald或Wolf方法);
  • 能量最小化;
  • NVE、NVT和NPT系综中的分子动力学模拟;
  • NVT系综中的蒙特卡罗模拟;
  • 等等!更多详细信息请参阅文档

入门

Lumol提供用于运行模拟的命令行工具;以及用于使用现有构建块编写您自己的模拟算法的Rust库。

文档

文档托管在这里,分为两部分

  • 用户手册包含了如何将Lumol作为命令行工具使用的信息,以及完整的输入文件文档。如果您想将Lumol作为模拟引擎使用,而不编写代码,请使用此文档。
  • 要将在您自己的代码中使用Lumol作为库,我们有一个开发者文档,其中包含了所有库公共函数的文档,以及大多数函数的示例。

作为命令行工具安装

您需要一个稳定的Rust编译器,如果您还没有,请获取一个。然后,您可以通过运行以下命令下载代码、构建并安装它:

cargo install --git https://github.com/lumol-org/lumol

这将产生一个位于~/.cargo/binlumol二进制文件。

作为库使用

您可以将Lumol作为依赖项添加到项目的Cargo.toml

[dependencies]
lumol = {git = "https://github.com/lumol-org/lumol"}

Lumol中实现新算法的教程即将推出。在等待过程中,您可以在这里提问

贡献

如果您想为Lumol做出贡献,有以下几种途径:改进文档和帮助解决语言问题;在您的系统上测试代码以发现错误;添加新算法和势函数;提供功能请求。在开始新工作之前,请先和我们聊一聊,或者打开一个问题来讨论改进。我们还有针对贡献者的建议

Lumol由Guillaume Fraux创建并维护。参与代码贡献的人员包括(按字母顺序)

许可

本软件采用BSD许可协议,请参阅LICENSE文件以获取法律文本。

除非您明确说明,否则您有意提交以包含在本工作中的任何贡献,都应按相同的BSD许可协议进行许可,不附加任何额外条款或条件。

无运行时依赖