Difference between revisions of "Tutorials download"

From The Yambo Project
Jump to navigation Jump to search
(Created page with list of files to download)
 
m (Menu level decreased)
Line 5: Line 5:
* from the Yambo GIT tutorial repository  
* from the Yambo GIT tutorial repository  


=== From the Yambo Virtual Machine (VM)  ===
== From the Yambo Virtual Machine (VM)  ==
If you are using the VM, a recent version of the tutorial files is provided.
If you are using the VM, a recent version of the tutorial files is provided.
Follow these [[Yambo_Virtual_Machine#Updating_the_Yambo_tutorial_files| instructions]] to update the tutorial files to the most recent version.
Follow these [[Yambo_Virtual_Machine#Updating_the_Yambo_tutorial_files| instructions]] to update the tutorial files to the most recent version.


=== From the Yambo website ===
== 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.  
If you are using your own installation or the docker, the files needed to run the tutorials can be downloaded from the lists below.  


Line 20: Line 20:
   hBN
   hBN


====Files needed for modular tutorials====
===Files needed for modular tutorials===
All of the following should be downloaded prior to following the modular tutorials:
All of the following should be downloaded prior to following the modular tutorials:


Line 37: Line 37:
|}
|}


====Files needed for stand-alone tutorials====
===Files needed for stand-alone tutorials===
At the start of each tutorial you will be told which specific file needs to be downloaded:
At the start of each tutorial you will be told which specific file needs to be downloaded:


Line 68: Line 68:
|}
|}


=== From the Git Tutorial Repository (advanced users) ===
== From the Git Tutorial Repository (advanced users) ==
If you are using your own installation or the docker, the [https://github.com/yambo-code/tutorials tutorials repository] contains the updated tutorials CORE databases. To use it
If you are using your own installation or the docker, the [https://github.com/yambo-code/tutorials tutorials repository] contains the updated tutorials CORE databases. To use it
  $ git clone https://github.com/yambo-code/tutorials.git YAMBO_TUTORIALS
  $ git clone https://github.com/yambo-code/tutorials.git YAMBO_TUTORIALS
  $ cd YAMBO_TUTORIALS
  $ cd YAMBO_TUTORIALS
  $ ./setup.pl -install
  $ ./setup.pl -install

Revision as of 10:34, 14 September 2023

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:

Tutorial 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:

Tutorial File(s)
Silicon Silicon.tar.gz
Silicon_Electron-Phonon.tar.gz
LiF LiF.tar.gz
Aluminum Aluminum.tar.gz
GaSb GaSb.tar.gz
AlAs AlAs.tar.gz
Hydrogen_Chain Hydrogen_Chain.tar.gz
MoS2 for HPC MoS2_HPC_tutorial.tar.gz
MoS2 for HPC shorter version MoS2_2Dquasiparticle_tutorial.tar.gz
Yambopy for QE databases_qepy
Yambopy for YAMBO 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