.. _miscellaneous:

Miscellaneous
=============

This page collects pointers to related projects and external resources
that UPET builds on or integrates with.


Related documentation
---------------------

UPET is built on top of the `metatensor <https://docs.metatensor.org>`_
ecosystem. Additional documentation for the underlying libraries and
engines can be found in:

- `metatensor <https://docs.metatensor.org>`_ — the core data format for
  atomistic machine learning.
- `metatomic <https://docs.metatensor.org/metatomic/>`_ — the runtime for
  running metatensor-based models in atomistic simulation engines.
- `metatrain <https://docs.metatensor.org/metatrain/>`_ — the training and
  evaluation framework for the PET architecture and other models.

Useful starting points:

- `Training a model
  <https://docs.metatensor.org/metatrain/latest/generated_examples/0-beginner/00-basic-usage.html>`_
- `Fine-tuning
  <https://docs.metatensor.org/metatrain/latest/generated_examples/0-beginner/02-fine-tuning.html>`_
- `LAMMPS interface
  <https://docs.metatensor.org/metatomic/latest/engines/lammps.html>`_
- `i-PI interface
  <https://docs.metatensor.org/metatomic/latest/engines/ipi.html>`_


Atomistic Cookbook recipes
--------------------------

More examples for **ASE, i-PI, and LAMMPS** are available in the
`Atomistic Cookbook
<https://atomistic-cookbook.org/examples/pet-mad/pet-mad.html>`_.

A local gallery of UPET example scripts is also built into this
documentation — see the :doc:`Examples gallery <generated_examples/index>`.