====== FileReadDresdenFPLO ======

###
The function //FileReadDresdenFPLO(path_to_out)// reads in the output file of the FPLO calculation. This function only reads information necessary for creating a TB Hamiltonian (using the Wannier orbitals from FPLO wan output) and is used to later generate the [[documentation:language_reference:objects:tightbinding:start|tight binding]] object. See also the function [[documentation:language_reference:functions:readfplo|ReadFPLO()]].
###

===== Input =====

  * path_to_out: (string) path to the FPLO output file.

===== Output =====

  * pointer to the FPLO output generated inside Quanty.

===== Example =====

###
A simple example of an FPLO calculation and downloading down on NiO:
###

==== Input ====
<code Quanty Example.Quanty>
print("Reading the FPLO output file")
FPLOOut = FileReadDresdenFPLO("DFT/out.wan")

print(FPLOOut)

print("Creating the TB object from FPLOOut")
TB = TightBindingDefFromDresdenFPLO(FPLOOut)

print("HTB.Name:")
print(HTB.Name)
 
print("\nHTB.Cell:")
print(HTB.Cell)
 
print("\nHTB.Atoms:")
print(HTB.Atoms)

print("\nHTB.NAtoms:")
print(HTB.NAtoms)
</code>

==== Result ====
<file Quanty_Output>
Reading the FPLO output file
FPLO input
Creating the TB object from FPLOOut
TB.Name:
NiO

TB.Cell:
{ { 0 , 3.9476378751116 , 3.9476378751116 } , 
  { 3.9476378751116 , 0 , 3.9476378751116 } , 
  { 3.9476378751116 , 3.9476378751116 , 0 } }

TB.Atoms:
{ { Ni , 
  { 0 , 0 , 0 } , 
  { { 3d , 
  { d_{xy} , d_{yz} , d_{3z^2-r^2} , d_{xz} , d_{x^2-y^2} } } } } , 
  { O , 
  { -3.9476378751116 , -3.9476378751116 , -3.9476378751116 } , 
  { { 2p , 
  { p_y , p_z , p_x } } } } }

TB.NAtoms:
2
</file>

===== Table of contents =====
{{indexmenu>.#1}}