Skip to content

Commit 749ab17

Browse files
HaoZekeLuthaf
authored andcommitted
docs(variants): update engine support
1 parent 524cfb9 commit 749ab17

File tree

2 files changed

+53
-20
lines changed

2 files changed

+53
-20
lines changed

docs/src/engines/eon.rst

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,60 @@ eOn
88

99
* - Official website
1010
- How is metatomic supported?
11-
* - https://theochemui.github.io/eOn/
11+
* - https://eondocs.org/
1212
- In the official Github version
1313

1414

1515
Supported model outputs
1616
^^^^^^^^^^^^^^^^^^^^^^^
1717

18-
Only the :ref:`energy <energy-output>` output is supported in eOn, as a custom
19-
``Potential``. This allows running methods, including:
18+
The eOn interface primarily utilizes the :ref:`energy <energy-output>` output to
19+
compute forces via autograd and drive molecular dynamics or saddle point
20+
searches.
2021

21-
- Saddle search methods
22-
- Single ended (dimer method, GPR accelerated dimer)
23-
- Double ended (Nudged Elastic Band with energy weighted strings)
24-
- Adaptive Kinetic Monte Carlo (aKMC) for long time scale simulations
22+
Additionally, the interface supports the :ref:`energy_uncertainty
23+
<energy-uncertainty-output>` output. When enabled, the client checks per-atom
24+
uncertainties against a user-defined threshold and flags or terminates
25+
calculations that enter unreliable regions of the potential energy surface.
26+
27+
This allows running methods including:
2528

26-
With the engine integration, it is possible to run these with interatomic
27-
potentials in ``metatomic`` format; distributing the calculation on GPUs as
28-
well.
29+
- **Saddle search methods:**
30+
- Single ended (dimer method, GPR accelerated dimer)
31+
- Double ended (Nudged Elastic Band with energy weighted strings, OCI-NEB)
32+
- **Long timescale simulations:**
33+
- Adaptive Kinetic Monte Carlo (aKMC)
34+
- Parallel Replica Dynamics
2935

3036
How to install the code
3137
^^^^^^^^^^^^^^^^^^^^^^^
3238

33-
Please refer to latest `eOn documentation`_ about how to install it.
39+
Please refer to the latest `eOn documentation`_ for installation instructions.
3440

35-
.. _eOn documentation: https://theochemui.github.io/eOn/install/metatomic.html
41+
.. _eOn documentation: https://eondocs.org/install/metatomic.html
3642

3743
How to use the code
3844
^^^^^^^^^^^^^^^^^^^
3945

4046
.. note::
4147

42-
Here we assume you already have an exported model that you want to use in your
43-
simulations. Please see :ref:`this tutorial <atomistic-tutorial-export>` to
44-
learn how to manually create and export a model; or use a tool like
45-
`metatrain`_ to create a model based on existing architectures and your own
46-
dataset.
48+
This guide assumes the existence of an exported model for use in simulations.
49+
Please see :ref:`this tutorial <atomistic-tutorial-export>` to learn how to
50+
manually create and export a model, or use a tool like `metatrain`_ to create
51+
a model based on existing architectures and custom datasets.
4752

48-
.. _metatrain: https://github.com/metatensor/metatrain
53+
.. _metatrain: https://github.com/metatensor/metatrain
4954

5055
The metatomic interface in eOn provides a custom Metatomic Potential that can be
5156
used in combination with any existing eOn runs, both server (aKMC) or client
5257
(dimer, NEB). The relevant configuration is:
5358

59+
Basic Configuration
60+
"""""""""""""""""""
61+
62+
To enable the potential, specify ``metatomic`` in the ``[Potential]`` block and
63+
provide the model path:
64+
5465
.. code-block:: ini
5566
5667
[Potential]
@@ -59,6 +70,11 @@ used in combination with any existing eOn runs, both server (aKMC) or client
5970
[Metatomic]
6071
model_path = # $FULL_PATH/pet-mad-full-best.pt
6172
62-
Where it is more robust to use the complete model path, especially for the adaptive kinetic monte carlo runs. Complete details of the input file specification are present in the `corresponding reference documentation`_.
73+
Advanced Configuration
74+
""""""""""""""""""""""
75+
76+
The interface exposes additional parameters to control uncertainty
77+
quantification and model variants. Complete details of the input file
78+
specification reside in the `corresponding reference documentation`_.
6379

64-
.. _corresponding reference documentation: https://theochemui.github.io/eOn/user_guide/index.html
80+
.. _corresponding reference documentation: https://eondocs.org/user_guide/metatomic_pot

docs/src/outputs/variants.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,20 @@ The following simulation engines can use variants for all their supported output
4444
:link-type: ref
4545

4646
|lammps-logo|
47+
48+
.. grid-item-card::
49+
:text-align: center
50+
:padding: 1
51+
:link: engine-ipi
52+
:link-type: ref
53+
54+
|ipi-logo|
55+
56+
.. grid-item-card::
57+
:text-align: center
58+
:padding: 1
59+
:link: engine-eon
60+
:link-type: ref
61+
62+
|eon-logo|
63+
|eon-logo-dark|

0 commit comments

Comments
 (0)