Skip to content
Snippets Groups Projects
Commit 66a06ed0 authored by Marcin Kirsz's avatar Marcin Kirsz
Browse files

Update installation.rst

parent 8b35af2a
No related branches found
No related tags found
1 merge request!39Main
Pipeline #50730 passed
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment