From c4d846939dc0c980d944a317907a89c91a546658 Mon Sep 17 00:00:00 2001
From: GAUDRY Emilie <emilie.gaudry@univ-lorraine.fr>
Date: Thu, 15 Aug 2024 12:39:57 +0000
Subject: [PATCH] Update file README.md
---
README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 78b5a80..60693f8 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
### Prerequisites
-The code uses SOAP descriptors through the Dscribe Library, Machine Learning tools of the scikit-learn Library and the Atomic Simulation Environment (ASE) Library.
+Three main libraries are required to run the code : Dscribe (SOAP descriptors), Scikit-learn (Machine Learning tools) and ASE (Atomic Simulation Environment).
-Here is the list of libraries you need to install to execute the code:
+More precisely :
- python==3.10
- ase==3.22.1
- scikit-learn==1.4.1
@@ -12,7 +12,7 @@ Here is the list of libraries you need to install to execute the code:
- scipy==1.12.0
- matplotlib==3.8.3
-All of them can be installed via `pip` , e.g.
+All libraries can be installed via `pip` , e.g.
```
pip install -r requirements.txt
```
@@ -20,9 +20,9 @@ pip install -r requirements.txt
## Usage
-The code builts Energy Adsorption Map (EAM) using machine learning.
+The code builts Energy Adsorption Maps (EAMs) using machine learning.
-The running file "run.py" (i) trains a model from a training set containing adsorption energies calculated on selected sites (".traj" file), and (ii) predicts adsorption energies of new sites located on a n $\times$ n regular grid above the surface. Results are written in the file "result.txt".
+The file "run.py" (i) trains a model from a training set containing adsorption energies calculated on selected sites (".traj" file), and (ii) predicts adsorption energies of new sites located on a n $\times$ n regular grid above the surface. Results are written in the file "result.txt".
The ".traj" file contains data useful to describe the simulation box, the atomic positions, the grid (n) as well as parameters for the SOAP descriptors and the Gaussian Process Regression.
--
GitLab