Skip to content

Commit

Permalink
Add MLIP Tutorial (#4982)
Browse files Browse the repository at this point in the history
Add a Tutorial on Machine-Learning Interatomic Potentials.
  • Loading branch information
kodiakhq[bot] authored Oct 28, 2024
2 parents f73f0f5 + 4331aae commit 1f672a0
Show file tree
Hide file tree
Showing 5 changed files with 768 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/tutorials/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ add_subdirectory(constant_pH)
add_subdirectory(widom_insertion)
add_subdirectory(electrodes)
add_subdirectory(grand_canonical_monte_carlo)
add_subdirectory(mlip)

configure_file(Readme.md ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
configure_file(convert.py ${CMAKE_CURRENT_BINARY_DIR})
3 changes: 3 additions & 0 deletions doc/tutorials/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ physical systems.
* **Raspberry electrophoresis**
Extended objects in a Lattice-Boltzmann fluid, raspberry particles.
[Guide](raspberry_electrophoresis/raspberry_electrophoresis.ipynb)
* **Machine-learned interatomic potential**
Atomistic simulations using the MACE-MP-0 model.
[Guide](mlip/mlip.ipynb)

### Advanced tutorials

Expand Down
22 changes: 22 additions & 0 deletions doc/tutorials/mlip/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#
# Copyright (C) 2016-2024 The ESPResSo project
#
# This file is part of ESPResSo.
#
# ESPResSo is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ESPResSo is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#

configure_tutorial_target(TARGET tutorial_mlip DEPENDS mlip.ipynb)

nb_export(TARGET tutorial_mlip SUFFIX "" FILE "mlip.ipynb")
22 changes: 22 additions & 0 deletions doc/tutorials/mlip/NotesForTutor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Machine-learned interatomic potential

## Physics learning goals

* Short introduction to how machine-learned inter-atomic potentials (MLPs) work.
* Visualisation of dissociation of sulfuric acid in water.
* Ground state calculations of small molecules MLPs
* Learn about the shortcomings of the lack of interpretability of MLPs.

After the tutorial, students should be able to:

* Explain how MLP derived results can be hard to explain, e.g., is the dissociation real or an artifact.
* Understand how to use the ESPResSo engine with MLPs.
* Perform ground state calculations and small quantum mechanically accurate simulations.

## ESPResSo learning goals

* Interfacing ESPResSo with an MLP.
* Interfacing ESPResSo with ASE.
* Performing geometry minimisation.
* Creating and filling simulation boxes.
* Setting thermostats and running MD.
Loading

0 comments on commit 1f672a0

Please sign in to comment.