Skip to content

Commit 6eb1ce3

Browse files
committed
Examples: update active learning installation instructions
1 parent f9ae382 commit 6eb1ce3

1 file changed

Lines changed: 37 additions & 7 deletions

File tree

Examples/sscha_and_aiida/README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
# Instructions
22

3-
We provide here the script `run_aiida_sscha.py`, which performs a thermal expansion calculation using SSCHA and aiida-quantumespresso.
3+
We provide here some scripts to run SSCHA using AiiDA, FLARE machine-learning potential, and a combination of the two as on-the-fly active learning.
44

5-
It is preferable to execute the example that you already have some experience with both the SSCHA and AiiDA-QuantumEspresso codes. Nevertheless, you can try following the instructions and to run the example.
5+
* `run_aiida_sscha.py`, which performs a thermal expansion calculation using SSCHA and aiida-quantumespresso.
6+
* `run_flare_sscha.py`, which performs a thermal expansion calculation using SSCHA and FLARE machine-learning interatomic potential.
7+
* `run_aiida_flare_sscha.py`, which performs an on-the-fly active learning SSCHA calculation using aiida-quantumespresso for DFT and FLARE as the ML potential.
8+
9+
It is preferable to execute the example that you already have some experience with both the SSCHA and AiiDA-QuantumESPRESSO codes. Nevertheless, you can try following the instructions and to run the example.
610

711
## Installation
812

9-
We recommend to install all the packages via `mamba` (which is based on top of `conda`). After having installed `mamba`, you can simply run the following:
13+
We recommend to install all the packages via `mamba` (which is based on `conda`). After having installed `mamba`, you can simply run the following:
1014

1115
```console
12-
> mamba create -n aiida-sscha -c conda-forge python gfortran libblas lapack openmpi julia openmpi-mpicc pip numpy scipy spglib aiida-core
13-
> pip install ase quippy-ase cellconstructor python-sscha aiida-quantumespresso aiida-pseudo
14-
> mamba activate aiida-sscha
16+
> mamba create -n sscha-aiida -c conda-forge python gfortran "blas=*=openblas" openblas lapack julia pip numpy scipy spglib pkg-config aiida-core
17+
> pip install ase cellconstructor python-sscha aiida-quantumespresso aiida-pseudo
18+
> mamba activate sscha-aiida
1519
```
20+
Then, you should configure an AiiDA profile and the pw.x code in order to use the example script (see also Prerequisites section).
1621

17-
Then, you should configure an AiiDA profile in order to use the example script (see also Prerequisites section).
22+
For on-the-fly active learning you also need the FLARE package:
23+
24+
```console
25+
> git clone --depth 1 https://github.com/mir-group/flare.git
26+
> cd flare
27+
> pip install .
28+
```
1829

1930
## Prerequisites
2031

@@ -23,6 +34,7 @@ You need to have installed in the same environment:
2334
- `cellconstructor`
2435
- `aiida-core`
2536
- `aiida-quantumespresso`
37+
- (optional, for active learning) `mir-flare`
2638

2739
For the AiiDA part, it is essential the dameon is running and you have:
2840
1. Configured a computer where to run the code (e.g. on your own laptop; see `aiida-core` docs for further details)
@@ -33,6 +45,8 @@ Please refer to the aiida-core and aiida-quantumespresso for further installatio
3345

3446
## How-to run
3547

48+
### SSCHA with the aiida-quantumespresso interface
49+
3650
Open the `run_aiida_sscha.py` and change the data according to your needs and local installation. Then simply
3751

3852
```console
@@ -45,4 +59,20 @@ Usually an actual production run would take a while. We suggest to use instead
4559
> nohup python run_aiida_sscha.py > run_aiida_sscha.log &
4660
```
4761

62+
or a submit script at glance.
63+
64+
### On-the-fly active learning SSCHA with aiida-quantumespresso and FLARE interface
65+
66+
Open the `run_aiida_flare_sscha.py` and change the data according to your needs and local installation. Then simply
67+
68+
```console
69+
> python run_aiida_flare_sscha.py > run_aiida_sscha.log
70+
```
71+
72+
Usually an actual production run would take a while. We suggest to use instead
73+
74+
```console
75+
> nohup python run_aiida_sscha.py > run_aiida_sscha.log &
76+
```
77+
4878
or a submit script at glance.

0 commit comments

Comments
 (0)