From 66a06ed054406c7a07f21a58ac4e57eb8f834528 Mon Sep 17 00:00:00 2001
From: Marcin Kirsz <marcin.kirsz@ed.ac.uk>
Date: Wed, 22 Jan 2025 12:23:33 +0000
Subject: [PATCH] Update installation.rst
---
docs/source/installation.rst | 25 ++++++++++++++++---------
1 file changed, 16 insertions(+), 9 deletions(-)
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index bb43a16..531dec3 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -3,7 +3,21 @@
Installation
============
-Installing Tadah! Software
+This section provides step-by-step instructions for installation of Tadah!MLIP and Tadah!LAMMPS.
+
+.. _requirements:
+
+Requirements
+------------
+
+Both Tadah!MLIP and Tadah!LAMMPS utilize CMake for configuration and building of its components.
+The Tadah!LAMMPS interface and Tadah!MLIP toolkit require C++11 and C++17 compatible compilers, respectively.
+LAPACK and ScaLAPACK (Tadah!MLIP MPI version only) must be available on the user’s system.
+
+Other necessary libraries are either included in the codebase or downloaded during the compilation process.
+The internet connection is required during the installation process.
+
+Installing Tadah!MLIP Software
--------------------------
Tadah!MLIP provides a command-line interface binary, ``tadah``, for developing machine learning interatomic potentials.
@@ -17,14 +31,7 @@ To obtain Tadah!MLIP, clone the main branch using:
git clone https://git.ecdf.ed.ac.uk/tadah/tadah.mlip.git
-.. _requirements:
-
-Requirements
-............
-
-Tadah!MLIP includes all necessary libraries, so no external downloads are needed.
-The internet connection is required during the installation process.
.. _building_tadah:
@@ -192,7 +199,7 @@ The following libraries can be compiled, depending on the build settings:
Compiling and Linking with Library
..................................
-For C++ library use, compile with C++17 or higher. Include library headers using the prefix `tadah/`.
+For C++ library use, compile with C++17 or higher. Include library headers using the prefix `tadah/` and link relevant libraries. For ``libtadah.mlip`` it is often the case that both ``libtadah.models`` and ``libtadah.core`` must be linked as well.
.. code-block:: c
--
GitLab