List of all recipes

This section contains the list of all compiled recipes, including those that are not part of any of the other sections.

A ML model for the electron density of states
This tutorial would go through the entire machine learning framework for the electronic density of states (DOS). It will cover the construction of the DOS and SOAP descriptors from ase Atoms and eigenenergy results. A simple neural network will then be constructed and the model parameters, along with the energy reference will be optimized during training. A total of three energy reference will be used, the average Hartree potential, the Fermi level, and an optimized energy reference starting from the Fermi level energy reference. The performance of each model is then compared.
A ML model for the electron density of states
Atomistic Water Model for Molecular Dynamics
In this example, we demonstrate how to construct a metatomic model for flexible three and four-point water model, with parameters optimized for use together with quantum-nuclear-effects-aware path integral simulations (cf. Habershon et al., JCP (2009)). The model also demonstrates the use of torch-pme, a Torch library for long-range interactions, and uses the resulting model to perform demonstrative molecular dynamics simulations.
Atomistic Water Model for Molecular Dynamics
Batch run of CP2K calculations
This is an example how to perform single point calculations based on list of structures using CP2K using its reftraj functionality. The inputs are a set of structures in :download:`example.xyz` using the DFT parameters defined in :download:`reftraj_template.cp2k`. The reference DFT parameters are taken from Cheng et al. Ab initio thermodynamics of liquid and solid water 2019. Due to the small size of the test structure and convergence issues, we have decreased the size of the CUTOFF_RADIUS from 6.0\,\mathrm{Å} to 3.0\,\mathrm{Å}. For actual production calculations adapt the template!
Batch run of CP2K calculations
Computing NMR shielding tensors using ShiftML
This example shows how to compute NMR shielding tensors using a point-edge transformer model trained on the ShiftML dataset.
Computing NMR shielding tensors using ShiftML
Conservative fine-tuning for a PET model
This example demonstrates a "conservative fine-tuning" (or equivalently, "non-conservative pre-training") strategy. This consists in training a model using (faster) direct, non-conservative force predictions, and then fine-tuning it with backpropagated forces to achieve an accurate conservative model.
Conservative fine-tuning for a PET model
Constant-temperature MD and thermostats
This recipe gives a practical introduction to finite-temperature molecular dynamics simulations, and provides a guide to choose the most appropriate thermostat for the simulation at hand.
Constant-temperature MD and thermostats
Equivariant linear model for polarizability
In this example, we demonstrate how to construct a metatensor atomistic model for the polarizability tensor of molecular systems. This example uses the featomic library to compute equivariant descriptors, and scikit-learn to train a linear regression model. The model can then be used in an ASE calculator. You could also have a look at this recipe based on scalar/tensorial models, which provides an alternative approach for equivariant learning of tensors.
Equivariant linear model for polarizability
Equivariant model for tensorial properties based on scalar features
In this example, we demonstrate how to train a metatensor atomistic model on dipole moments and polarizabilities of small molecular systems, using a model that combines scalar descriptors with equivariant tensorial components that depend in a simple way from the molecular geometry. You may also want to read this recipe for a linear polarizability model, which provides an alternative approach for tensorial learning. The model is trained with metatrain and can then be used in an ASE calculator.
Equivariant model for tensorial properties based on scalar features
Finding Reaction Paths with eOn and a Metatomic Potential
This example describes how to find the reaction pathway for oxadiazole formation from N₂O and ethylene. We will use the PET-MAD metatomic model to calculate the potential energy and forces.
Finding Reaction Paths with eOn and a Metatomic Potential
Fine-tuning the PET-MAD universal potential
This example demonstrates how to fine-tune the PET-MAD universal ML potential on a new dataset using metatrain. This allows adapting the model to a specialized task by retraining it on a more focused, domain-specific dataset.
Fine-tuning the PET-MAD universal potential
Generalized Convex Hull construction for the polymorphs of ROY
This notebook analyzes the structures of 264 polymorphs of ROY, from Beran et Al, Chemical Science (2022), comparing the conventional density-energy convex hull with a Generalized Convex Hull (GCH) analysis (see Anelli et al., Phys. Rev. Materials (2018)). It uses features computed with featomic and uses the directional convex hull function from scikit-matter to make the figure.
Generalized Convex Hull construction for the polymorphs of ROY
Geometry relaxation with unconstrained MLIPs
This recipe shows how to perform geometry optimization with unconstrained machine-learning interatomic potentials (MLIPs), and what tools are available to control symmetry during relaxation.
Geometry relaxation with unconstrained MLIPs
Hamiltonian Learning for Molecules with Indirect Targets
This tutorial introduces a machine learning (ML) framework that predicts Hamiltonians for molecular systems. Another one of our cookbook examples demonstrates an ML model that predicts real-space Hamiltonians for periodic systems. While we use the same model here to predict a molecular Hamiltonians, we further finetune these models to optimise predictions of different quantum mechanical (QM) properties of interest, thereby treating the Hamiltonian predictions as an intermediate component of the ML framework. More details on this hybrid or indirect learning framework can be found in ACS Cent. Sci. 2024, 10, 637−648. and our preprint arXiv:2504.01187.
Hamiltonian Learning for Molecules with Indirect Targets
Learning Capabilities with torchpme
This example demonstrates the capabilities of the torchpme package, focusing on learning target charges and utilizing the :class:`CombinedPotential` class to evaluate potentials that combine multiple pairwise interactions with optimizable weights.
Learning Capabilities with torchpme
Local Prediction Rigidity analysis
In this tutorial, we calculate the SOAP descriptors of an amorphous silicon dataset using featomic, then compute the local prediction rigidity (LPR) for the atoms of a "test" set before and after modifications to the "training" dataset has been made.
Local Prediction Rigidity analysis
Long-distance Equivariants: a tutorial
This tutorial explains how Long range equivariant descriptors can be constructed using featomic and the resulting descriptors be used to construct a linear model with equisolve
Long-distance Equivariants: a tutorial
Long-stride trajectories with a universal FlashMD model
For a quickstart on how to use FlashMD with ASE, you can go here.
Long-stride trajectories with a universal FlashMD model
MD using direct-force predictions with PET-MAD
Evaluating forces as a direct output of a ML model accelerates their evaluation, by up to a factor of 3 in comparison to the traditional approach that evaluates them as derivatives of the interatomic potential. Unfortunately, as discussed e.g. in this paper, doing so means that forces are not conservative, leading to instabilities and artefacts in many modeling tasks, such as constant-energy molecular dynamics. Here we demonstrate the issues associated with direct force predictions, and ways to mitigate them, using the generally-applicable PET-MAD potential. See also this recipe for examples of using PET-MAD for basic tasks such as geometry optimization and conservative MD, and this for an example of how to use direct forces to accelerate training.
MD using direct-force predictions with PET-MAD
ML collective variables in PLUMED with metatomic
This example shows how to build a metatomic model that computes order parameters for a Lennard-Jones cluster, and how to use it with the PLUMED package to run a metadynamics simulation.
ML collective variables in PLUMED with metatomic
ML/MM Simulations with GROMACS and Metatomic
In this tutorial we simulate and analyse an alanine dipeptide in water using a machine learning potential for the solute while the solvent is treated with a classical force field. This setup is commonly referred to as an ML/MM simulation and follows very similar ideas to QM/MM.
ML/MM Simulations with GROMACS and Metatomic
Mendeleev clusters
This example demonstrates how to stress test universal machine learning potentials by simulating a complex nanoparticle containing all the elements that are supported by the target model. We will use the version 1.5.0 of the PET-MAD universal potential, which covers 102 elements, using ASE, and i-PI.
Mendeleev clusters
Multiple time stepping and ring-polymer contraction
This notebook provides an introduction to multiple time stepping and ring polymer contraction, two closely-related techniques, that are geared towards reducing the cost of calculations by separating slowly-varying (and computationally-expensive) components of the potential energy from the fast-varying (and hopefully cheaper) ones.
Multiple time stepping and ring-polymer contraction
PCA/PCovR Visualization of a training dataset for a potential
This example uses featomic and metatensor to compute structural properties for the structures in a training dataset for a ML potential. These are then used with simple dimensionality reduction algorithms (implemented in sklearn and skmatter) to obtain a simplified description of the dataset, that is then visualized using chemiscope.
PCA/PCovR Visualization of a training dataset for a potential
Path integral metadynamics
This example shows how to run a free-energy sampling calculation that combines path integral molecular dynamics to model nuclear quantum effects and metadynamics to accelerate sampling of the high-free-energy regions.
Path integral metadynamics
Path integral molecular dynamics
This example shows how to run a path integral molecular dynamics simulation using i-PI, analyze the output and visualize the trajectory in chemiscope. It uses LAMMPS as the driver to simulate the q-TIP4P/f water model.
Path integral molecular dynamics
Periodic Hamiltonian learning
This tutorial explains how to train a machine learning model for the electronic Hamiltonian of a periodic system. Even though we focus on periodic systems, the code and techniques presented here can be directly transferred to molecules.
Periodic Hamiltonian learning
Phonon dispersions with unconstrained models and uncertainty quantification
Phonon dispersion curves are important experimental probes of the lattice dynamics of a material, and are commonly used to validate MLIPs. They are also crucial for computing temperature-dependent properties such as free energies and thermal conductivity.
Phonon dispersions with unconstrained models and uncertainty quantification
Quantum heat capacity of water
This example shows how to estimate the heat capacity of liquid water from a path integral molecular dynamics simulation. The dynamics are run with i-PI, and LAMMPS is used as the driver to simulate the q-TIP4P/f water model.
Quantum heat capacity of water
Ring Polymer Instanton Rate Theory: Tunneling Rates
This notebook introduces the calculation of tunneling rates using ring-polymer instanton rate theory. A comprehensive presentation of the instanton formalism can be found in the review article by J. Richardson, Int. Rev. Phys. Chem., 37, 171, 2018, while the implementation within i-PI is described in V. Kapil et al., Comp. Phys. Commun., 236, 214, 2020. Additional practical details are available in Yair Litman's doctoral thesis.
Ring Polymer Instanton Rate Theory: Tunneling Rates
Rotating equivariants
This example shows how to rotate equivariant properties of atomic structures using the scipy and quaternionic libraries. The equivariant properties for this example are computed by the featomic library.
Rotating equivariants
Sample and Feature Selection with FPS and CUR
In this tutorial we generate descriptors using featomic, then select a subset of structures using both the farthest-point sampling (FPS) and CUR algorithms implemented in scikit-matter. Finally, we also generate a selection of the most important features using the same techniques.
Sample and Feature Selection with FPS and CUR
The PET-MAD universal potential
This example demonstrates how to use the PET-MAD model with ASE, i-PI and LAMMPS. PET-MAD is a "universal" machine-learning forcefield trained on a dataset that aims to incorporate a very high degree of structural diversity.
The PET-MAD universal potential
Thermal conductivity from the Boltzmann transport equation
This recipe shows how to compute lattice thermal conductivity \kappa by solving the phonon Boltzmann transport equation (BTE) with kALDo and the PET-MAD universal machine-learning potential via the UPET calculator.
Thermal conductivity from the Boltzmann transport equation
Uncertainty Quantification with PET-MAD
This recipe demonstrates three ways of computing errors on the outputs of ML potential-driven simulations, using as an example the PET-MAD model and its built-in uncertainty quantification (UQ) capabilities.
Uncertainty Quantification with PET-MAD
Water orientation in a pulsed electric field
Energy dissipation in water is very fast and more efficient than in many other liquids. This behavior is commonly attributed to the intermolecular interactions associated with hydrogen bonding. This effect has been studied intensively by experiments, ab initio, and classical simulations in the work by Elgabarty et al.. Here, we will re run some of the classical force field molecular dynamics (MD) simulations of the paper using the GROMACS package to compute the timeseries of the dipole moments as well as the energy.
Water orientation in a pulsed electric field