Tutorials: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
mNo edit summary
 
(155 intermediate revisions by 13 users not shown)
Line 1: Line 1:
If you are starting out with Yambo, or even an experienced user, we recommend that you complete the following tutorials before trying to use Yambo for your system.
The tutorials are meant to give some introductory background to the key concepts behind Yambo. Practical topics such as convergence are also discussed.
Nonetheless, users are invited to first read and study the [[lectures|background material]] in order to get familiar with the fundamental physical quantities.
We recommend that you complete the tutorials before trying to use Yambo for your system.


Each tutorial is fairly standalone, although some require that you have completed previous ones.
You must have a working environment where both Yambo and Yambopy (and eventually QE or abinit) are installed.
If you are starting out with Yambo, we suggest to follow [[Setting up Yambo|this page]] with a detailed explanation about how to set up all you need for running the tutorials.


The tutorials are meant to give some introductive background to the key concepts connected to the use of the Yambo code. Basic concepts like convergence of the calculations are also discussed. Still, the users are invited to read and study the [[lectures|pertinent documentation]] in order to get used to the most fundamental Physical quantities.
In the left main menu you can access the different Tutorials sections:
 
* [[Tutorials_download|Download information]]
Some of the tutorials are provided with the yambo input files. Also the output of the calculations are given to be used as a reference. For all systems the ground state input files (Abinit and/or PWscf) and pseudopotentials are provided.
* [[Tutorials_standalone|Stand-alone tutorials]]
 
* [[Tutorials_modular|Modular tutorials]] and corresponding [[Modules|Modules]]
== Getting started ==
* [https://enccs.github.io/max-coe-workshop/day5-tutorials/ More tutorials in Markdown]
 
For each TUTORIAL (Solid_LiF, Solid_Al, ...) , therefore, you can download the ground state files (zip archive named TUTORIAL_ground_state.zip) and generate the Yambo databases from your own by running abinit/PWscf and a2y/p2y. In this case the Yambo input and reference files are contained in the zip file (TUTORIAL_reference_files.zip). Alternatively, if (and only if) you have compiled yambo with the NetCDF support you can directly download the zip files containing the Yambo core databases (TUTORIAL_NETCDF_databases_and_reference_files.zip). These are generated using the NetCDF interface in order to be readable in any platform.
 
After you have downloaded the tutorial zip files and unziped them you should have now a tutorial tree:
 
localhost:> ls
YAMBO_TUTORIALS/
 
localhost:> ls  YAMBO_TUTORIALS/
COPYING  Fantastic_Dimensions/  Hydrogen_Chain/  README  Solid_LiF/ Solid_Al/ SiH4/ ...
In each folder you will find an Abinit or Pwscf subfolder in case you have downloaded the ground state zip files and the YAMBO subfolder. The tutorials start by entering the YAMBO subfolder and followinf the informations provided in the tutorial documentation.
 
== Tutorial files ==
To follow the tutorials, you must first download or copy data files for each system. Files are distributed as gzipped tarballs. Always extract the tarballs '''in the same place.'''<br>
Available systems are: <code>hBN.tar.gz</code>, <code>hBN-2D.tar.gz</code>. You will need both ''hBN'' and ''hBN-2D'' tarballs.
 
Files can be found here:
*[http://www.yambo-code.org/tutorials/files/hBN.tar.gz hBN.tar.gz]
*[http://www.yambo-code.org/tutorials/files/hBN-2D.tar.gz hBN-2D.tar.gz]
 
== Stand alone tutorials ==
<!-- [[Instructions for CECAM students]] -->
 
[[Hydrogen chain]]
 
== Modules ==
An alternative way to learn Yambo is through a more detailed look at our '''[[Modules|documentation modules]]'''. These provide a focus on the input parameters, run time behaviour, and underlying physics behind each yambo task or runlevel. Although they can be followed separately, they are better followed as part of the more structured tutorials given above.

Latest revision as of 15:36, 31 October 2024

The tutorials are meant to give some introductory background to the key concepts behind Yambo. Practical topics such as convergence are also discussed. Nonetheless, users are invited to first read and study the background material in order to get familiar with the fundamental physical quantities. We recommend that you complete the tutorials before trying to use Yambo for your system.

You must have a working environment where both Yambo and Yambopy (and eventually QE or abinit) are installed. If you are starting out with Yambo, we suggest to follow this page with a detailed explanation about how to set up all you need for running the tutorials.

In the left main menu you can access the different Tutorials sections:

Retrieved from "https://wiki.yambo-code.eu/wiki/index.php?title=Tutorials&oldid=8115"