Difference between revisions of "Tutorial-v.1.0.0"

From salmon
Jump to: navigation, search
Line 1: Line 1:
 
== Getting Started ==
 
== Getting Started ==
Welcome!
+
Welcome to SALMON Tutorial!
In this tutorial, we explain the use of SALMON from the very beginning, taking a few examples that cover applications of SALMON in several directions.  
+
 
 +
In this tutorial, we explain the use of SALMON from the very beginning, taking a few samples that cover applications of SALMON in several directions.  
 
We assume that you are in the computational environment of UNIX/Linux OS.  
 
We assume that you are in the computational environment of UNIX/Linux OS.  
First you need to download  
+
First you need to download and install SALMON in your computational environment.  
and install SALMON in your computational environment.  
+
If you have not yet done it, do it following the instruction, [[download-v.1.0.0]] and [[install and Run-v.1.0.0]].   
You may find detailed instruction in [[download-v.1.0.0]] and [[install and Run-v.1.0.0]].   
 
  
As described in [[Install and Run-v.1.0.0]], you are required to prepare at least input file and pseudopotential files to run SALMON.
+
As described in [[Install and Run-v.1.0.0]], you are required to prepare at least an input file and pseudopotential files to run SALMON.
In the following, we present input files for several example calculations.
+
In the following, we present input files for several sample calculations and provide a brief explanation of the namelist variables that appear in the input files.
We provide a brief explanation of the namelists that appear in the input files.
+
You may modify the input files to execute for your own calculations.
Pseudopotential files of elements that appear in the example are also attached.
+
Pseudopotential files of elements that appear in the samples are also attached.
We also present main output files and explain what they include.
+
We also present explanations of main output files.
  
You can run SALMON at your own environment just getting files from this page.
+
We present 6 tutorials.
You may also be able to modify the input file reading the explanation of the namelists.
 
  
We present 6 samples.
+
First 3 tutorials (Tutorial-1 ~ 3) are for an isolated molecule, acetylene C2H2.  
 
+
If you are interested in learning electron dynamics calculations in isolated systems, please look into these tutorials.
First 3 samples (Sample-1 ~ 3) are for an isolated molecule, acetylene C2H2.  
+
In SALMON, we usually calculate the ground state solution first.
If you are interested in learning electron dynamics calculations in isolated systems, please look into these samples.
+
This is illustrated in [[#Tutorial-1: Ground state of C2H2 molecule|Tutorial-1]].
In SALMON, we usually calculate the ground state DFT solution first.
+
After finishing the ground state calculation, two tutorials of electron dynamics calculations are prepared.
This is illustrated in  
+
[[#Tutorial-2: Polarizability and photoabsorption of C2H2 molecule|Tutorial-2]]  
[[#Sample-1: Ground state of C2H2 molecule|Sample-1]].
+
illustrates the calculation of linear optical responses in real time, obtaining polarizability and photoabsorption of the molecule.
After finishing the ground state calculations, two samples of electron dynamics calculations are prepared.
+
[[#Tutorial-3: Electron dynamics in C2H2 molecule under a pulsed electric field|Tutorial-3]
[[#Sample-2: Polarizability and photoabsorption of C2H2 molecule|Sample-2]]  
 
illustrates the calculation of linear optical responses in real time, getting polarizability and photoabsorption of the molecule.
 
[[#Sample-3: Electron dynamics in C2H2 molecule under a pulsed electric field|Sample-3]
 
 
illustrates the calculation of electron dynamics in the molecule under a pulsed electric field.
 
illustrates the calculation of electron dynamics in the molecule under a pulsed electric field.
  
Next 2 samples (Sample-4 ~ 5) are for a crystalline silicon.
+
Next 2 tutorials (Tutorial-4 ~ 5) are for a crystalline solid, silicon.
If you are interested in learning electron dynamics calculations in extended periodic systems, please look into these samples.
+
If you are interested in learning electron dynamics calculations in extended periodic systems, please look into these tutorials.
Since the time evolution calculation is much more time consuming than the ground state calculation in extended systems,
+
Since ground state calculations of small unit-cell systems are not computationally expensive
we recommend to calculate the ground and the time evolution calculations as a single job.
+
and a time evolution calculation is usually much more time-consuming than the ground state calculation,
[[#Sample-4: Ground state and dielectric function of crystalline silicon|Sample-4]]
+
we recommend to run the ground and the time evolution calculations as a single job.
illustrates the calculation of linear response properties of crystalline silicon, getting the dielectric function.
+
The following two tutorials are organized in that way.
[[#Sample-5: Ground state and electron dynamics in crystalline silicon under a pulsed electric field|Sample-5]]
+
[[#Tutorial-4: Ground state and dielectric function of crystalline silicon|Tutorial-4]]
 +
illustrates the calculation of linear response properties of crystalline silicon to obtain the dielectric function.
 +
[[#Tutorial-5: Ground state and electron dynamics in crystalline silicon under a pulsed electric field|Tutorial-5]]
 
illustrates the calculation of electron dynamics in the crystalline silicon induced by a pulsed electric field.
 
illustrates the calculation of electron dynamics in the crystalline silicon induced by a pulsed electric field.
  
The final sample (Sample-6) is for a propagation of a pulsed light in a bulk medium,  
+
The final tutorial (Tutorial-6) is for an irradiation and a propagation of a pulsed light in a bulk silicon,
coupling Maxwell equations for the electromagnetic fields of pulsed light and the electron dynamics in unit cells.
+
coupling Maxwell equations for the electromagnetic fields of the pulsed light and the electron dynamics in the unit cells.
This calculation is quite time-consuming and is only possible using massively parallel supercomputers.
+
This calculation is quite time-consuming and is recommended to execute using massively parallel supercomputers.
[[#Sample-6: Coupled multiscale calculation of electrons and electromagnetic fields in crystalline silicon|Sample-6]]
+
[[#Tutorial-6: Coupled multiscale calculation of electrons and electromagnetic fields in crystalline silicon|Tutorial-6]]
illustrates the calculation of a pulsed, linearly polarized light irradiating normally on a surface of bulk silicon.
+
illustrates the calculation of a pulsed, linearly polarized light irradiating normally on a surface of a bulk silicon.
  
 
== C2H2 (isolated molecules) ==
 
== C2H2 (isolated molecules) ==
  
=== Sample-1: Ground state of C2H2 molecule ===
+
=== Tutorial-1: Ground state of C2H2 molecule ===
In this sample, we learn the preparation of the ground state solution of an isolated system such as molecules,
+
In this tutorial, we learn the calculation of the ground state solution of acetylene (C2H2) molecule,
taking acetylene (C2H2) molecule as an example.
+
solving the static Kohn-Sham equation.
We assume that atomic positions of a molecule to be calculated are known (use the measured geometry, or prepare by other calculations).
+
To run the code, following files are used:
 +
 
 +
 
 +
 
 
You can look at a sample input file, [[C2H2_gs_v1_0_0.inp|C2H2_gs.inp]], or download the sample input file as well as pseudopotential files of Carbon and Hydrogen, [[File:C2H2_gs_v1_0_0.zip|C2H2_gs_v1_0_0.inp]]).
 
You can look at a sample input file, [[C2H2_gs_v1_0_0.inp|C2H2_gs.inp]], or download the sample input file as well as pseudopotential files of Carbon and Hydrogen, [[File:C2H2_gs_v1_0_0.zip|C2H2_gs_v1_0_0.inp]]).
 
You can run SALMON using these files.
 
You can run SALMON using these files.

Revision as of 08:26, 9 November 2017

Getting Started

Welcome to SALMON Tutorial!

In this tutorial, we explain the use of SALMON from the very beginning, taking a few samples that cover applications of SALMON in several directions. We assume that you are in the computational environment of UNIX/Linux OS. First you need to download and install SALMON in your computational environment. If you have not yet done it, do it following the instruction, download-v.1.0.0 and install and Run-v.1.0.0.

As described in Install and Run-v.1.0.0, you are required to prepare at least an input file and pseudopotential files to run SALMON. In the following, we present input files for several sample calculations and provide a brief explanation of the namelist variables that appear in the input files. You may modify the input files to execute for your own calculations. Pseudopotential files of elements that appear in the samples are also attached. We also present explanations of main output files.

We present 6 tutorials.

First 3 tutorials (Tutorial-1 ~ 3) are for an isolated molecule, acetylene C2H2. If you are interested in learning electron dynamics calculations in isolated systems, please look into these tutorials. In SALMON, we usually calculate the ground state solution first. This is illustrated in Tutorial-1. After finishing the ground state calculation, two tutorials of electron dynamics calculations are prepared. Tutorial-2 illustrates the calculation of linear optical responses in real time, obtaining polarizability and photoabsorption of the molecule. [[#Tutorial-3: Electron dynamics in C2H2 molecule under a pulsed electric field|Tutorial-3] illustrates the calculation of electron dynamics in the molecule under a pulsed electric field.

Next 2 tutorials (Tutorial-4 ~ 5) are for a crystalline solid, silicon. If you are interested in learning electron dynamics calculations in extended periodic systems, please look into these tutorials. Since ground state calculations of small unit-cell systems are not computationally expensive and a time evolution calculation is usually much more time-consuming than the ground state calculation, we recommend to run the ground and the time evolution calculations as a single job. The following two tutorials are organized in that way. Tutorial-4 illustrates the calculation of linear response properties of crystalline silicon to obtain the dielectric function. Tutorial-5 illustrates the calculation of electron dynamics in the crystalline silicon induced by a pulsed electric field.

The final tutorial (Tutorial-6) is for an irradiation and a propagation of a pulsed light in a bulk silicon, coupling Maxwell equations for the electromagnetic fields of the pulsed light and the electron dynamics in the unit cells. This calculation is quite time-consuming and is recommended to execute using massively parallel supercomputers. Tutorial-6 illustrates the calculation of a pulsed, linearly polarized light irradiating normally on a surface of a bulk silicon.

C2H2 (isolated molecules)

Tutorial-1: Ground state of C2H2 molecule

In this tutorial, we learn the calculation of the ground state solution of acetylene (C2H2) molecule, solving the static Kohn-Sham equation. To run the code, following files are used:


You can look at a sample input file, C2H2_gs.inp, or download the sample input file as well as pseudopotential files of Carbon and Hydrogen, File:C2H2 gs v1 0 0.zip). You can run SALMON using these files.

In the input file, namelists variables are specified. Most of them are mandatory to run the ground state calculation. You may find explanation of the namelist variables that appear in the input file in Explanations for C2H2_gs input files-v.1.0.0. It will help you to prepare an input file that you want to calculate. A complete list of the namelists that can be used in input files can be found at ???.

After the calculation, following output files are created in the directory that you run the code, C2H2.info, File:C2H2 info v1 0 0.zip) and additional output files (File:C2H2 gs output v1 0 0.zip



HOMO.pngDns.pngElf.png

Sample-2: Polarizability and photoabsorption of C2H2 molecule

Sample-3: Electron dynamics of C2H2 molecule under a pulsed electric field

Crystalline silicon (periodic solids)

Sample-4: Ground state and dielectric function of crystalline silicon

Sample-5: Ground state and electron dynamics in crystalline silicon under a pulsed electric field

Light propagation in bulk silicon (Maxwell + TDDFT)

Sample-6: Coupled multiscale calculation of electrons and electromagnetic fields in crystalline silicon