[WIP] Support general ASE Calculator for general MLIP MD simulations #738
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Given that some of the popular MLIPs lean on ASE Calculator, this PR aims to add ASE Calculator support for MD simulations in a similar manner to #134 and #489. The design is similar to existing forcefield but allows user to pass any subclass of ASE Calculator and run various of dynamics supported by ASE MD module.
The design should be kept general and abstract so that we can avoid code duplication and won't need to add more ASE-based MLIPs in the future. This actually makes more sense than the existing relaxation implementation where most of them run ASE calculator as Relaxer at the bottom level. By doing so we can also ensure that all the MLIPs fairly run on the same settings of dynamics .
TODO
mask
anddyn.set_fraction_traceless(0)
ASEJob
Checklist
Work-in-progress pull requests are encouraged, but please put [WIP] in the pull request
title.
Before a pull request can be merged, the following items must be checked:
The easiest way to handle this is to run the following in the correct sequence on
your local machine. Start with running
ruff
andruff format
on your new code. This willautomatically reformat your code to PEP8 conventions and fix many linting issues.
Run ruff on your code.
type check your code.
Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply run
pre-commit install
and a check will be run prior to allowing commits.