Tutorials download

From The Yambo Project
Revision as of 07:47, 18 June 2024 by Davide (talk | contribs) (→‎Files needed for stand-alone tutorials: added R_methyloxirane)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The tutorial CORE databases can be obtained

From the Yambo Virtual Machine (VM)

If you are using the VM, a recent version of the tutorial files is provided. Follow these instructions to update the tutorial files to the most recent version.

From the Yambo website

If you are using your own installation or the docker, the files needed to run the tutorials can be downloaded from the lists below.

After downloading the tar.gz files just unpack them in the YAMBO_TUTORIALS folder. For example

$ mkdir YAMBO_TUTORIALS
$ mv hBN.tar.gz YAMBO_TUTORIALS
$ cd YAMBO_TUTORIALS
$ tar -xvfz hBN.tar.gz
$ ls YAMBO_TUTORIALS
  hBN

Files needed for modular tutorials

All of the following should be downloaded prior to following the modular tutorials:

Matrial File(s)
hBN hBN.tar.gz
hBN-convergence-kpoints.tar.gz
hBN-2D.tar.gz
hBN-2D-para.tar.gz

Files needed for stand-alone tutorials

At the start of each tutorial you will be told which specific file needs to be downloaded:

Material File(s)
Silicon Silicon.tar.gz
Silicon_Electron-Phonon.tar.gz
LiF LiF.tar.gz
SiH4 SiH4.tar.gz
R_methyloxirane R_methyloxirane_DBs.tar.gz
Iron Iron_DBs.tar.gz
Iron_Inputs.tar.gz
Iron_abinit_gs_files.tar.gz
Aluminum Aluminum.tar.gz
GaSb GaSb.tar.gz
AlAs AlAs.tar.gz
Hydrogen_Chain Hydrogen_Chain.tar.gz
MoS2 MoS2_HPC_tutorial.tar.gz
MoS2_2Dquasiparticle_tutorial.tar.gz
Yambopy databases_qepy
databases_yambopy

From the Git Tutorial Repository (advanced users)

If you are using your own installation or the docker, the tutorials repository contains the updated tutorials CORE databases. To use it

$ git clone https://github.com/yambo-code/tutorials.git YAMBO_TUTORIALS
$ cd YAMBO_TUTORIALS
$ ./setup.pl -install