Skip to content

Commit 5f8102a

Browse files
committed
Update engine docs to refer to the metatomic integrations
1 parent cb25b17 commit 5f8102a

File tree

3 files changed

+8
-26
lines changed

3 files changed

+8
-26
lines changed

docs/src/engines/chemiscope.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
Chemiscope
44
==========
55

6-
.. warning::
7-
8-
Chemiscope still uses the old metatensor-based atomistic models, and has not
9-
yet been updated to execute metatomic models.
10-
116
.. list-table::
127
:header-rows: 1
138

@@ -29,10 +24,10 @@ The code can be installed with the following command:
2924

3025
.. code-block:: bash
3126
32-
pip install chemiscope[metatensor]
27+
pip install chemiscope[metatomic]
3328
3429
3530
How to use the code
3631
^^^^^^^^^^^^^^^^^^^
3732

38-
See the example from https://chemiscope.org/docs/examples/8-explore-with-metatensor.html.
33+
See the example from https://chemiscope.org/docs/examples/8-explore-with-metatomic.html.

docs/src/engines/ipi.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
i-PI
44
====
55

6-
.. warning::
7-
8-
i-PI still uses the old metatensor-based atomistic models, and has not yet
9-
been updated to execute metatomic models.
10-
116
.. list-table::
127
:header-rows: 1
138

@@ -52,14 +47,14 @@ with the ``i-pi-driver-py`` command.
5247
.. code-block:: bash
5348
5449
# minimal version
55-
i-pi-driver-py -m metatensor -o template.xyz,model.pt
50+
i-pi-driver-py -m metatomic -o template.xyz,model.pt
5651
5752
# all possible options
58-
i-pi-driver-py -m metatensor -o template.xyz,model.pt,device=cpu,extensions=path/to/extensions,check_consistency=False
53+
i-pi-driver-py -m metatomic -o template.xyz,model.pt,device=cpu,extensions=path/to/extensions,check_consistency=False
5954
60-
The minimal options to give to the ``metatensor`` client are the path to a
55+
The minimal options to give to the ``metatomic`` client are the path to a
6156
template structure for the simulated system (``template.xyz`` in the example
62-
above) and the path to the metatensor model (``model.pt`` above). The template
57+
above) and the path to the metatomic model (``model.pt`` above). The template
6358
structure must be a file that `ASE`_ can read. The code only uses it to get the
6459
atomic types (assumed to be the atomic numbers) matching all particles in the
6560
system.

docs/src/engines/plumed.rst

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
PLUMED
44
======
55

6-
.. warning::
7-
8-
PLUMED still uses the old metatensor-based atomistic models, and has not yet
9-
been updated to execute metatomic models.
10-
116

127
.. list-table::
138
:header-rows: 1
@@ -23,9 +18,6 @@ Supported model outputs
2318

2419
PLUMED supports the :ref:`features <features-output>` output, and can use it as
2520
collective variables to perform advanced sampling such as metadynamics.
26-
Additionally, it also supports a custom output named ``"plumed::cv"``, with the
27-
same semantics and metadata structure as the :ref:`features <features-output>`
28-
output.
2921

3022
How to install the code
3123
^^^^^^^^^^^^^^^^^^^^^^^
@@ -37,5 +29,5 @@ How to use the code
3729

3830
See the official `syntax reference`_ in PLUMED documentation.
3931

40-
.. _installation instruction: https://www.plumed.org/doc-v2.10/user-doc/html/_m_e_t_a_t_e_n_s_o_r_m_o_d.html
41-
.. _syntax reference: https://www.plumed.org/doc-v2.10/user-doc/html/_m_e_t_a_t_e_n_s_o_r.html
32+
.. _installation instruction: https://www.plumed.org/doc-v2.10/user-doc/html/_m_e_t_a_t_o_m_i_c_m_o_d.html
33+
.. _syntax reference: https://www.plumed.org/doc-v2.10/user-doc/html/_m_e_t_a_t_o_m_i_c.html

0 commit comments

Comments
 (0)