Skip to content

Wannier90 files

Warning

Several APIs (for example read_amn, write_amn, read_chk, and write_chk) support Fortran unformatted (binary) files. Those files are compiler/platform dependent, so portability across all environments is not guaranteed.

Prefer text formats for maximum interoperability, and use binary when you need compatibility with a specific upstream/downstream toolchain.

Current tests cover:

  • Linux + gfortran 11.2

Public API

WannierIO.read_amn Function
julia
read_amn(file)
read_amn(file, ::FortranText)
read_amn(file, ::FortranBinaryStream)

Read wannier90 amn file.

Arguments

  • file: The name of the input file, or an IO.

Return

  • A: length-n_kpts vector, each element is a n_bands * n_wann matrix.

  • header: first line of the file

Note there are three versions of this function: the 1st one is a wrapper function that automatically detect the format (text or binary) of the file, and does some additional pretty printing to give user a quick hint of the dimensions of the A matrix; it internally calls the 2nd or the 3rd version for actual reading.

Wannier90 only has Fortran text format for amn, however I wrote a custom version of QE pw2wannier90.x that can output Fortran binary format (using Fortran stream IO) to save some disk space. The 1st function auto detect the file format so it is transparent to the user.

source
WannierIO.write_amn Function
julia
write_amn(file, A; header=default_header(), binary=false)
write_amn(file, A, ::FortranText; header=default_header())
write_amn(file, A, ::FortranBinaryStream; header=default_header())

Write wannier90 amn file.

Arguments

  • file: The name of the output file, or an IO.

  • A: a length-n_kpts vector, each element is a n_bands * n_wann matrix

Keyword arguments

  • header: 1st line of the file

  • binary: write as Fortran unformatted file, which is the Wannier90 default. Here the binary kwargs is provided for convenience.

Same as read_amn there are three versions of this function, the 1st one is a wrapper function, it calls the 2nd or the 3rd version depending on the binary kwargs.

source
WannierIO.read_w90_band Method
julia
read_w90_band(prefix, recip_lattice)

Arguments

  • prefix: prefix of the output files prefix_band.dat, prefix_band.kpt, and prefix_band.labelinfo.dat

  • recip_lattice: each column is a reciprocal lattice vector in Å.

Return

  • kpath: a CrystalBase.KPath object

  • eigenvalues: the eigenvalues of the band structure

Note

The read_w90_band(prefix) function returns a NamedTuple containing basis variables such as kpoints, symm_point_indices, etc. Here, once we know the recip_lattice, we can return a more convenient KPath.

source
WannierIO.read_w90_band Method
julia
read_w90_band(prefix)

Read prefix_band.dat, prefix_band.kpt, prefix_band.labelinfo.dat.

Arguments

  • prefix: prefix of the filenames (or called seedname in wannier90), NOT the full filename.

Return

  • x: n_kpts, x axis value of kpath, in cartesian length

  • eigenvalues: length-n_kpts vector, each element is a length-n_bands vector of band energies

  • kpoints: a vector of length n_kpts, fractional coordinates

  • kweights: a vector of length n_kpts, weights of kpoints

  • symm_point_indices: index of high-symmetry points in prefix_band.dat

  • symm_point_labels: name of high-symmetry points

source
WannierIO.read_w90_band_dat Method
julia
read_w90_band_dat(io)

Read prefix_band.dat file generated by wannier90.x, or prefix-band.dat file generated by postw90.x.

Return

  • x: n_kpts, x axis value of kpath, in cartesian length

  • eigenvalues: length-n_kpts vector, each elemnt is a length-n_bands vector of band energies

  • extras: optional (the postw90.x might generate a file with a third column), same size as eigenvalues, often the color of each eigenvalue, e.g., spin projection

source
WannierIO.read_w90_band_kpt Method
julia
read_w90_band_kpt(io)

Read a prefix_band.kpt file.

Return

  • kpoints: a vector of length n_kpts, fractional coordinates

  • kweights: a vector of length n_kpts, weights of kpoints

source
WannierIO.read_w90_band_labelinfo_dat Method
julia
read_w90_band_labelinfo_dat(io)

Read prefix_band.labelinfo file.

Return

  • symm_point_indices: index of high-symmetry points in prefix_band.dat

  • symm_point_labels: name of high-symmetry points

source
WannierIO.write_w90_band Method
julia
write_w90_band(prefix, kpath, eigenvalues)

Write prefix_band.dat, prefix_band.kpt, prefix_band.labelinfo.dat.

This is a more user-friendly version that works with CrystalBase.KPath; the WannierIO.write_w90_band(prefix; kwargs...) is the low-level version.

source
WannierIO.write_w90_band Method
julia
write_w90_band(
    prefix;
    x,
    eigenvalues,
    kpoints,
    kweights,
    symm_point_indices,
    symm_point_labels
)

Write prefix_band.dat, prefix_band.kpt, prefix_band.labelinfo.dat.

Arguments

  • prefix: prefix of prefix_band.dat, prefix_band.kpt, prefix_band.labelinfo.dat

Keyword Arguments

  • x: n_kpts, x axis value, in cartesian length

  • eigenvalues: length-n_kpts vector, each element is a length-n_bands vector of band energies

  • kpoints: length-n_kpts vector, fractional coordinates

  • kweights: a vector of length n_kpts, weights of kpoints

  • symm_point_indices: index of high-symmetry points in prefix_band.dat

  • symm_point_labels: name of high-symmetry points

source
WannierIO.write_w90_band_dat Method
julia
write_w90_band_dat(io; x, eigenvalues, extras)

Write prefix_band.dat file.

Arguments

  • file: The name of the output file, or an IO.

Keyword Arguments

  • x: n_kpts, x axis value, in cartesian length

  • eigenvalues: length-n_kpts vector, each element is a length-n_bands vector of band energies

  • extras: optional, same size as eigenvalues, will be written as the third column of prefix_band.dat. The prefix-band.dat file generated by postw90.x sometimes has a third column for e.g. the color of the eigenvalues

source
WannierIO.write_w90_band_kpt Method
julia
write_w90_band_kpt(io; kpoints, kweights)

Write prefix_band.kpt file.

Arguments

  • file: The name of the output file, or an IO.

Keyword Arguments

  • kpoints: length-n_kpts vector, fractional coordinates

  • kweights: n_kpts, optional, weights of kpoints, default to 1.0.

source
WannierIO.write_w90_band_labelinfo_dat Method
julia
write_w90_band_labelinfo_dat(
    io;
    x,
    kpoints,
    symm_point_indices,
    symm_point_labels
)

Write prefix_band.labelinfo.dat file.

Arguments

  • file: The name of the output file, or an IO.

Keyword Arguments

  • x: length-n_kpts x-axis coordinates (Cartesian path length)

  • kpoints: length-n_kpts vector of fractional coordinates

  • symm_point_indices: indices of high-symmetry points along the path

  • symm_point_labels: labels of high-symmetry points

source
WannierIO.gauge_matrices Method
julia
gauge_matrices(chk)

Extract the combined U = Udis * Uml matrices from Chk.

source
WannierIO.gauge_matrices_dis Method
julia
gauge_matrices_dis(chk)

Extract disentanglement Udis matrices from Chk.

source
WannierIO.read_chk Method
julia
read_chk(filename)
read_chk(file, ::FortranText)
read_chk(file, ::FortranBinary)

Read wannier90 chk checkpoint file.

Arguments

  • file: The name of the input file, or an IO.

Similar to read_amn, the 1st version auto detect chk file format (binary or text) and read it.

source
WannierIO.write_chk Function
julia
write_chk(filename, chk::Chk; binary=false)
write_chk(file, chk::Chk, ::FortranText)
write_chk(file, chk::Chk, ::FortranBinary)

Write wannier90 chk file.

Similar to write_amn, the 1st version is a convenience wrapper.

Arguments

  • file: The name of the output file, or an IO.

  • chk: the Chk struct

Keyword arguments

  • binary: write as Fortran binary file or not. Although wannier90 default is Fortran binary format, here the default is false since Fortran binary depends on compiler and platform, so it is not guaranteed to always work.
source
WannierIO.read_eig Function
julia
read_eig(file)
read_eig(file, ::FortranText)
read_eig(file, ::FortranBinaryStream)

Read the wannier90 eig file.

Arguments

  • file: The name of the input file, or an IO.

Return

  • eigenvalues: a lenth-n_kpts vector, each element is a length-n_bands vector

The 1st version is a convenience wrapper function for the 2nd and 3rd versions.

source
WannierIO.write_eig Function
julia
write_eig(file, eigenvalues; binary=false)
write_eig(file, eigenvalues, ::FortranText)
write_eig(file, eigenvalues, ::FortranBinaryStream)

Write eig file.

Arguments

  • file: The name of the output file, or an IO.

  • eigenvalues: a length-n_kpts vector, each element is a length-n_bands vector

Keyword arguments

  • binary: if true write in Fortran binary format.
source
WannierIO.write_HH_R_dat Method
julia
write_HH_R_dat(io, hhr)

Write the real space Hamiltonian to a prefix_HH_R.dat file.

Arguments

  • file: The name of the output file, or an IO.

  • hhr: a HHRDat struct

Note

Wannier90 postw90.x has a hidden input parameter effective_model, setting it to true and postw90.x will read this HH_R.dat to fill the real space Hamiltonian, and do subsequent Wannier interpolation, e.g., in BoltzWann. However, the vanilla postw90.x code does not take into account the degeneracy of R vectors, and also does not use MDRS interpolation. I have modified the postw90.x code to use MDRS, and also changed a bit the number of digits for the Hamiltonian in HH_R.dat, so that it is the same as the prefix_tb.dat file, i.e., from Fortran F12.6 to E15.8.

source
WannierIO.read_w90_hr_dat Method
julia
read_w90_hr_dat(io)

Read prefix_hr.dat.

Return

  • Rvectors: -vectors on which operators are defined

  • Rdegens: degeneracies of each -vector

  • H: Hamiltonian

  • header: the first line of the file

source
WannierIO.write_w90_hr_dat Method
julia
write_w90_hr_dat(io, hrdat)

Write prefix_hr.dat.

Arguments

See the fields of HrDat.

source
WannierIO.read_isym Method
julia
read_isym(io)

Read prefix.isym.

Return

A Isym with the following fields:

  • header::String: Header line.

  • n_symops::Int64: Number of symmetry operations.

  • spinors::Bool: Whether spinors are considered.

  • symops::Vector{SymOp}: Symmetry operations.

  • nkpts_ibz::Int64: Number of IBZ kpoints.

  • kpoints_ibz::Vector{Vec3{Float64}}: IBZ kpoints in fractional coordinates.

  • n_bands::Int64: Number of bands.

  • n_repmat_band::Int64: Number of representation matrices for symmetry operations in the little groups of all IBZ kpoints.

  • repmat_band::Vector{RepMatBand{n_bands}}: Representation matrices for symmetry operations in the little groups of all IBZ kpoints.

  • n_wann::Int64: Number of Wannier functions.

  • repmat_wann::Vector{RepMatWann{n_wann}}: Representation matrices for symmetry operations acting on the Wannier functions.

source
WannierIO.read_mmn Function
julia
read_mmn(file)
read_mmn(file, ::FortranText)
read_mmn(file, ::FortranBinaryStream)

Read wannier90 mmn file.

Arguments

  • file: The name of the input file, or an IO.

Return

  • Mmn struct containing the data in the file
source
WannierIO.write_mmn Function
julia
write_mmn(file, mmn; binary=false)
write_mmn(file, mmn, ::FortranText)
write_mmn(file, mmn, ::FortranBinaryStream)

Write wannier90 mmn file.

Arguments

  • file: The name of the output file, or an IO.

  • mmn: a Mmn struct

Keyword arguments

  • binary: if true write in Fortran binary format
source
WannierIO.read_nnkp Function
julia
read_nnkp(file)
read_nnkp(file, ::W90InputText)
read_nnkp(file, ::W90InputToml)

Read wannier90 nnkp file.

Arguments

  • file: The name of the input file, or an IO.

Return

  • lattice: each column is a lattice vector

  • recip_lattice: each column is a reciprocal lattice vector

  • kpoints: length-n_kpts vector, each element is Vec3, in fractional coordinates

  • projections: length-n_projs vector of HydrogenOrbital

  • auto_projections: optional, the number of Wannier functions n_wann for automatic initial projections

  • kpb_k: length-n_kpts vector, each element is a length-n_bvecs vector of integers, index of kpoints

  • kpb_G: length-n_kpts vector, each element is a length-n_bvecs vector, then each element is Vec3 for translations, fractional w.r.t recip_lattice

Wannier90 nnkp file is a plain text format, the 2nd version reads nnkp file in Wannier90 format. The thrid version read a TOML-format nnkp file, which is defined by this package, see write_nnkp. The 1st version auto detects the format and parse it.

source
WannierIO.write_nnkp Function
julia
write_nnkp(file, params; header)
write_nnkp(file, params, ::W90InputText; header)
write_nnkp(file, params, ::W90InputToml; header)

Write a nnkp file that can be used by DFT codes, e.g., QE pw2wannier90.

Arguments

  • file: The name of the output file, or an IO.

  • params: a Dict (or OrderedDict) of parameters to be written into the nnkp file

The params should have at least the following keys:

  • lattice: each column is a lattice vector

  • recip_lattice: each column is a reciprocal lattice vector

  • kpoints: length-n_kpts vector of Vec3, in fractional coordinates

  • kpb_k: length-n_kpts vector, each element is a length-n_bvecs vector of integers, index of kpoints

  • kpb_G: length-n_kpts vector, each element is a length-n_bvecs vector, then each element is a Vec3 for translation vector, fractional w.r.t. recip_lattice

The following keys are optional:

  • projections: optional, length-n_projs vector of HydrogenOrbital

  • auto_projections: optional, the number of Wannier functions n_wann for automatic initial projections. If given, write an auto_projections block

  • exclude_bands: if given, write the specified band indices in the exclude_bands block

Keyword arguments

  • header: first line of the file
source
WannierIO.read_w90_r_dat Method
julia
read_w90_r_dat(io)

Read prefix_r.dat.

Return

  • RDat struct containing the data in the file
source
WannierIO.write_w90_r_dat Method
julia
write_w90_r_dat(io, rdat)

Write prefix_r.dat.

Arguments

See the fields of RDat.

source
WannierIO.read_spn Function
julia
read_spn(filename)
read_spn(file, ::FortranText)
read_spn(file, ::FortranBinary)

Read the wannier90 spn file.

Arguments

  • file: The name of the input file, or an IO.

Return

  • Spn struct containing the data in the file
source
WannierIO.write_spn Function
julia
write_spn(filename, spn; binary=false)
write_spn(file, spn, ::FortranText)
write_spn(file, spn, ::FortranBinary)

Write the spn file.

Arguments

  • file: The name of the output file, or an IO.

  • spn: a Spn struct

source
WannierIO.read_w90_tb_dat Method
julia
read_w90_tb_dat(io)

Read prefix_tb.dat.

Return

  • TbDat struct containing the data in the file
source
WannierIO.write_w90_tb_dat Method
julia
write_w90_tb_dat(io, tbdat)

Write prefix_tb.dat.

Arguments

See the fields of TbDat.

source
WannierIO.read_uHu Function
julia
read_uHu(filename)
read_uHu(file, ::FortranText; transpose_band_indices=true)
read_uHu(file, ::FortranBinary; transpose_band_indices=true)

Read the wannier90 uHu file.

Arguments

  • file: The name of the input file, or an IO.

Keyword Arguments

  • transpose_band_indices: QE pw2wannier90.x writes the matrix in a strange transposed manner; if reading a QE-generated uHu file, this flag should be true to restore the band indices order, so that the returned matrix has the correct order, i.e., uHu[ik][ib1, ib2][m, n] is

Return

  • uHu: a length-n_kpts vector, each element is a n_bvecs * n_bvecs matrix, then each element is a n_bands * n_bands matrix

  • header: 1st line of the file

source
WannierIO.write_uHu Function
julia
write_uHu(filename, uHu; binary=false, header)
write_uHu(file, uHu, ::FortranText; header)
write_uHu(file, uHu, ::FortranBinary; header)

Write the uHu file.

Arguments

  • file: The name of the output file, or an IO.

  • uHu: a length-n_kpts vector, each element is a n_bvecs * n_bvecs matrix, then each element is a n_bands * n_bands matrix

Keyword Arguments

source
WannierIO.read_uIu Function
julia
read_uIu(filename)
read_uIu(file, ::FortranText; transpose_band_indices=true)
read_uIu(file, ::FortranBinary; transpose_band_indices=true)

Read the wannier90 uIu file.

Arguments

  • file: The name of the input file, or an IO.

Keyword Arguments

  • transpose_band_indices: QE pw2wannier90.x writes the matrix in a strange transposed manner; if reading a QE-generated uIu file, this flag should be true to restore the band indices order, so that the returned matrix has the correct order, i.e., uIu[ik][ib1, ib2][m, n] is

Return

  • uIu: a length-n_kpts vector, each element is a n_bvecs * n_bvecs matrix, then each element is a n_bands * n_bands matrix

  • header: 1st line of the file

source
WannierIO.write_uIu Function
julia
write_uIu(filename, uIu; binary=false, header)
write_uIu(file, uIu, ::FortranText; header)
write_uIu(file, uIu, ::FortranBinary; header)

Write the uIu file.

Arguments

  • file: The name of the output file, or an IO.

  • uIu: a length-n_kpts vector, each element is a n_bvecs * n_bvecs matrix, then each element is a n_bands * n_bands matrix

Keyword Arguments

source
WannierIO.read_unk Function
julia
read_unk(filename)
read_unk(file, ::FortranText)
read_unk(file, ::FortranBinary)

Read wannier90 UNK file for the periodic part of Bloch wavefunctions.

Arguments

  • file: The name of the input file, or an IO.

Return

  • ik: k-point index, start from 1

  • Ψ: periodic part of Bloch wavefunctions in real space, size = (n_gx, n_gy, n_gz, n_bands, n_spin)

source
WannierIO.write_unk Function
julia
write_unk(filename, ik, Ψ; binary=false)
write_unk(file, ik, Ψ, ::FortranText)
write_unk(file, ik, Ψ, ::FortranBinary)

Write UNK file for the periodic part of Bloch wavefunctions.

Arguments

  • file: The name of the output file, or an IO.

  • ik: at which kpoint? start from 1

  • Ψ: Bloch wavefunctions, size(Ψ) = (n_gx, n_gy, n_gz, n_bands, n_spin)

Keyword arguments

  • binary: write as Fortran unformatted file
source
WannierIO.read_win Function
julia
read_win(file; standardize=true)
read_win(file, ::W90InputText; standardize=true)
read_win(file, ::W90InputToml; standardize=true)

Read wannier90 input win file.

Arguments

  • file: The name of the input file, or an IO.

Keyword Arguments

  • standardize: sanity check and fix the input parameters, e.g., set num_bands = num_wann if num_bands is not specified, convert atoms_cart always to atoms_frac, etc. See also standardize_win!.
source
WannierIO.write_win Function
julia
write_win(file, params; header)
write_win(file, params, ::W90InputText; header)
write_win(file, params, ::W90InputToml; header)

Write input parameters into a wannier90 win file.

Arguments

  • file: The name of the output file, or an IO.

  • params: a Dict (or OrderedDict) of parameters to be written into the win file

Examples

julia
using OrderedCollections, WannierIO

params = OrderedDict(
    "num_wann" => 4,
    "num_bands" => 4,
    # unit_cell_cart is a matrix, its columns are the lattice vectors in angstrom
    "unit_cell_cart" => [
        0.0      2.71527  2.71527
        2.71527  0.0      2.71527
        2.71527  2.71527  0.0
    ],
    # atoms_frac is a vector of pairs of atom_label and fractional coordinates
    "atoms_frac" => [
        "Si" => [0.0, 0.0, 0.0],
        "Si" => [0.25, 0.25, 0.25],
    ],
    # each element in projections will be written as a line in the win file
    "projections" => [
        "random",
    ],
    "kpoint_path" => [
        ["G" => [0.0, 0.0, 0.0], "X" => [0.5, 0.0, 0.5]],
        ["X" => [0.5, 0.0, 0.5], "U" => [0.625, 0.25, 0.625]],
    ],
    "mp_grid" => [2, 2, 2],
    # kpoints is a matrix, its columns are the fractional coordinates
    "kpoints" => [
        [0.0, 0.0, 0.0],
        [0.0, 0.0, 0.5],
        [0.0, 0.5, 0.0],
        [0.0, 0.5, 0.5],
        [0.5, 0.0, 0.0],
        [0.5, 0.0, 0.5],
        [0.5, 0.5, 0.0],
        [0.5, 0.5, 0.5],
    ],
    # additional parameters, e.g.,
    "num_iter" => 500,
)
write_win("silicon.win", params)
source
WannierIO.read_wout Method
julia
read_wout(io; iterations)

Parse wannier90 wout file.

Keyword Arguments

  • iterations: if true, parse all the iterations of disentanglement and maximal localization. Default is false.

Return

  • lattice: each column is a lattice vector in Å

  • recip_lattice: each column is a reciprocal lattice vector in Å⁻¹

  • atom_labels: atomic labels

  • atom_positions: in fractional coordinates

  • kgrid: kpoint grid used in Wannierization

  • centers: center of each final WF, in Å

  • spreads: spread of each final WF, in Ų

  • sum_centers: sum of final WF centers, in Å

  • sum_spreads: sum of final WF spreads, in Ų

  • ΩI, ΩD, ΩOD, Ωtotal: final spread (components) in Ų

  • phase_factors: optional, global (multiplicative) phase factor for obtaining real-valued (or close to real) MLWFs

  • im_re_ratios: optional, maximum Im/Re ratio

  • iterations: disentanglement and max localization convergence history, only parsed when kwarg iterations=true

source
WannierIO.read_w90_wsvec_dat Method
julia
read_w90_wsvec_dat(io)

Read prefix_wsvec.dat.

Return

  • WsvecDat struct containing the data in the file
source
WannierIO.write_w90_wsvec_dat Method
julia
write_w90_wsvec_dat(io, wsvec)

Write prefix_wsvec.dat.

source

Private API

Lower-level helpers and internal utilities are documented here for power users. Most users should prefer the exported high-level functions above.

WannierIO.default_band_kpt_kweights Method
julia
default_band_kpt_kweights(kpoints)

Wannier90 default kweights in prefix_band.kpt is all 1.0.

source
WannierIO.read_w90_band_kpt_labelinfo Method
julia
read_w90_band_kpt_labelinfo(prefix, recip_lattice)

Read kpoints and labels from wannier90 formats: prefix_band.kpt, prefix_band.labelinfo.dat.

Arguments

  • prefix: the prefix of the input files prefix_band.kpt and prefix_band.labelinfo.dat

  • recip_lattice: the reciprocal lattice matrix

Returns

  • kpath: a CrystalBase.KPath object
source
WannierIO.write_w90_band_kpt_labelinfo Method
julia
write_w90_band_kpt_labelinfo(prefix, kpath)

Write kpoints into wannier90 formats: prefix_band.kpt, prefix_band.labelinfo.dat.

Arguments

  • prefix: the prefix of the output files prefix_band.kpt and prefix_band.labelinfo.dat

  • kpath: a CrystalBase.KPath object

Tip

This allows writing auto generated high-symmetry kpoints and labels from crystal structure (by CrystalBase.KSegment()) into files. Then other codes can use the kpoints for band structure calculations, e.g., QE pw.x bands calculation, or in the win input file for Wannier90.

Example

julia
using Spglib, Brillouin, CrystalBase, WannierIO
win = read_win("si2.win")
kseg = KSegment(win.unit_cell_cart, win.atoms_frac, win.atom_labels)
# Set the number of kpoints along the 1st segment to 100 points
kp = KPath(kseg, 100)
write_w90_kpt_label("si2", kp)
source
WannierIO.Chk Type

Struct for storing matrices in prefix.chk file.

julia
struct Chk{T<:Real}

One-to-one mapping to the wannier90 chk file, but renaming the variable names so that they are consistent with the rest of the code.

Fields

  • header: The header line, usually contains date and time

  • n_bands: number of bands, can be auto set in constructor according to dimensions of other variables

  • n_exclude_bands: number of excluded bands, can be auto set in constructor

  • exclude_bands: Indices of excluded bands, starts from 1. Vector of integers, size: n_exclude_bands

  • lattice: Matrix of size 3 x 3, each column is a lattice vector in Å unit

  • recip_lattice: Matrix of size 3 x 3, each column is a reciprocal lattice vector in Å⁻¹ unit

  • n_kpts: number of kpoints, can be auto set in constructor

  • kgrid: dimensions of kpoint grid, 3 integers

  • kpoints: kpoint coordinates, fractional, length-n_kpts vector

  • n_bvecs: number of b-vectors, can be auto set in constructor

  • n_wann: number of Wannier functions, can be auto set in constructor

  • checkpoint: a string to indicate the current step (after disentanglement, after maximal localization, ...) in wannier90

  • have_disentangled: Have finished disentanglement or not

  • ΩI: Omega invariant part of MV spreads, in Ų unit

  • dis_bands: Indices of bands taking part in disentanglement, not frozen bands! length-n_kpts vector, each element is a length-n_bands vector of bool. This is needed since W90 puts all the disentanglement bands in the first several rows of Udis, (and the first few columns of Udis are the frozen bands) so directly multiplying eigenvalues e.g. (Udis * U)' * diag(eigenvalues) * (Udis * U) is wrong!

  • n_dis: number of bands taking part in disentanglement at each kpoint. can be auto set in constructor from dis_bands

  • Udis: Semi-unitary matrix for disentanglement, length-n_kpts vector, each elment has size: n_bands x n_wann, i.e., the u_matrix_opt in wannier90

  • Uml: Unitary matrix for maximal localization, length-n_kpts vector, each element has size: n_wann x n_wann, i.e., the u_matrix in wannier90. The abbreviation ml stands for maximal localization, so as to differentiate from the (combined) unitary matrix U = Udis * Uml.

  • M: Wannier-gauge overlap matrix, length-n_kpts vector of length-n_bvecs vector, each element is a matrix of size n_wann x n_wann, i.e., the m_matrix in wannier90

  • r: Wannier function centers, length-n_wann vector, Cartesian coordinates in Å unit, i.e., the wannier_centres variable in wannier90

  • ω: Wannier function spreads, length-n_wann vector, Ų unit, i.e., the wannier_spreads variable in wannier90

source
WannierIO.Chk Method
julia
Chk(
    header,
    exclude_bands,
    lattice,
    recip_lattice,
    kgrid,
    kpoints,
    checkpoint,
    have_disentangled,
    ΩI,
    dis_bands,
    Udis,
    Uml,
    M,
    r,
    ω
)

Convenience constructor of Chk struct that auto set some fields.

source
Base.isapprox Method
julia
isapprox(a, b)

Compare two Chk objects.

source
WannierIO._check_eig_order Method
julia
_check_eig_order(eigenvalues; digits)

Check that eigenvalues are in order.

Some times there are small noises, use digits to set the number of digits for comparisons.

source
WannierIO._reshape_eig Method
julia
_reshape_eig(idx_b, idx_k, eig)

Reshape a vector of eigenvalues into a matrix of eigenvalues.

Auto detect the number of bands and kpoints.

source
WannierIO.HHRDat Type

Container for prefix_HH_R.dat data.

julia
struct HHRDat{T<:Real, IT<:Integer}

Fields

  • header: Header line

  • Rvectors: R vectors of length n_rvecs

  • Rdegens: Degeneracy vector for each R vector, or nothing

  • H: Hamiltonian of length n_rvecs, each element is a matrix with shape (n_wann, n_wann)

source
WannierIO.HrDat Type

Container for prefix_hr.dat data.

julia
struct HrDat{T<:Real, IT<:Integer}

Fields

  • header: Header line

  • Rvectors: R vectors on which operators are defined

  • Rdegens: Degeneracies of each R vector

  • H: Hamiltonian matrices in real space

source
WannierIO.Isym Type

Container for prefix.isym data.

julia
struct Isym{RB<:WannierIO.RepMatBand, RW<:WannierIO.RepMatWann}

Fields

  • header: Header line

  • n_symops: Number of symmetry operations

  • spinors: Whether spinors are considered

  • symops: Symmetry operations

  • nkpts_ibz: Number of IBZ kpoints

  • kpoints_ibz: IBZ kpoints in fractional coordinates

  • n_bands: Number of bands

  • n_repmat_band: Number of band representation matrices

  • repmat_band: Representation matrices for bands

  • n_wann: Number of Wannier functions

  • repmat_wann: Representation matrices for Wannier functions

source
WannierIO.RepMatBand Type

A representation matrix applied to the Bloch functions for a symmetry operation from the little group of a k-point.

This is the d matrix.

N is the number of bands.

source
WannierIO.RepMatWann Type

A representation matrix applied to the Wannier functions for a symmetry operation in real space.

This is the D matrix.

N is the number of Wannier functions.

source
WannierIO.SymOp Type

A symmetry operation g = {R|t} in real space, from the isym file.

source
WannierIO.build_mapping_ik_isym Method
julia
build_mapping_ik_isym(repmat_band; nkpts_ibz, n_symops)

Build the index mapping from ik_ibz and isym to the index in repmat_band.

source
WannierIO.Mmn Type

Container for wannier90 mmn data.

julia
struct Mmn{T<:Real, IT<:Integer}

Fields

  • header: Header line (1st line of the file)

  • M: Overlap matrices. Length-n_kpts vector, each element is a length-n_bvecs vector, then each element is a n_bands * n_bands matrix.

  • kpb_k: Neighbor kpoint indices. Length-n_kpts vector, each element is a length-n_bvecs vector of integers for the indices of the neighboring kpoints.

  • kpb_G: Translation vectors for neighboring kpoints. Length-n_kpts vector, each element is a length-n_bvecs vector of of Vec3{Int}, which are the translation vectors. The translation vector G is defined as b = kpoints[kpb_k[ik][ib]] + kpb_G[ik][ib] - kpoints[ik], where b is the ib-th bvector of the ik-th kpoint.

source
WannierIO._check_dimensions_M_kpb Method
julia
_check_dimensions_M_kpb(M, kpb_k, kpb_G)
source
WannierIO._check_dimensions_kpb Method

Check the dimensions between the quantities are consistent.

source
WannierIO.HydrogenOrbital Type

Hydrogen-like analytic orbitals.

Follows the definition in Wannier90, see https://wannier90.readthedocs.io/en/latest/user_guide/wannier90/postproc/#projections-block https://wannier90.readthedocs.io/en/latest/user_guide/wannier90/projections/

julia
struct HydrogenOrbital <: WannierIO.Orbital

Fields

  • center: 3 real numbers of the projection center, in fractional coordinates

  • n: positive integer, principle quantum number   for the radial function

  • l: non-negative integer, angular momentum   of real spherical harmonics

  • m: integer, magnetic quantum number ,   

  • α: positive real number, controlling the spread of the radial function

  • zaxis: 3 real numbers, the z-axis from which the polar angle is measured, default is [0, 0, 1]

  • xaxis: 3 real numbers, the x-axis from which the azimuthal angle is measured, must be orthogonal to zaxis, default is [1, 0, 0]

source
WannierIO._nnkp_block_isend Method

Check if a line marks the end of a named block in an nnkp file.

source
WannierIO._nnkp_block_mustend Method

Assert that a line marks the end of a named block.

source
WannierIO._nnkp_block_nextline Method

Read one line from an nnkp block and strip surrounding whitespace.

source
WannierIO._nnkp_check_line Method

Check whether an nnkp line starts a block and return (isblock, block_name).

source
WannierIO._nnkp_check_required_blocks Method

Validate required nnkp blocks after parsing.

source
WannierIO._nnkp_check_required_params Method
julia
_nnkp_check_required_params(kwargs)
source
WannierIO._nnkp_parse_block! Method

Dispatch to nnkp block parsers and store parsed values in params.

source
WannierIO._nnkp_parse_block_auto_projections Method

Parse auto_projections block and return the number of Wannier functions.

source
WannierIO._nnkp_parse_block_kpoints Method

Parse kpoints block and return a vector of k-points.

source
WannierIO._nnkp_parse_block_nnkpts Method

Parse nnkpts block and return (kpb_k, kpb_G).

source
WannierIO._nnkp_parse_block_projections Method

Parse projections block and return a vector of HydrogenOrbital.

source
WannierIO._nnkp_parse_block_real_lattice Method

Parse real_lattice block and return a 3x3 lattice matrix.

source
WannierIO._nnkp_parse_block_recip_lattice Method

Parse recip_lattice block and return a 3x3 reciprocal lattice matrix.

source
WannierIO._nnkp_read_array Method

Parse a numeric line from nnkp blocks.

source
WannierIO._nnkp_skip_block Method

Skip unknown nnkp blocks by consuming lines up to the matching end <block>.

source
WannierIO._nnkp_validate_write_params Method

Validate nnkp parameters required by the text writer.

source
WannierIO._nnkp_write_block_auto_projections Method

Write auto_projections block.

source
WannierIO._nnkp_write_block_exclude_bands Method

Write exclude_bands block.

source
WannierIO._nnkp_write_block_kpoints Method

Write kpoints block.

source
WannierIO._nnkp_write_block_nnkpts Method

Write nnkpts block.

source
WannierIO._nnkp_write_block_projections Method

Write projections block.

source
WannierIO._nnkp_write_block_real_lattice Method

Write real_lattice block.

source
WannierIO._nnkp_write_block_recip_lattice Method

Write recip_lattice block.

source
WannierIO._nnkp_write_header Method

Write nnkp header and fixed metadata line.

source
WannierIO.RDat Type

Container for prefix_r.dat data.

julia
struct RDat{T<:Real, IT<:Integer}

Fields

  • header: Header line

  • Rvectors: -vectors on which operators are defined

  • r_x: x-component of position operator

  • r_y: y-component of position operator

  • r_z: z-component of position operator

source
WannierIO.Spn Type

Container for wannier90 spn data.

julia
struct Spn{T<:Real}

Fields

  • header: Header line

  • Sx: Spin x matrices. A length-n_kpts vector, each element is a n_bands-by-n_bands matrix.

  • Sy: Spin y matrices. A length-n_kpts vector, each element is a n_bands-by-n_bands matrix.

  • Sz: Spin z matrices. A length-n_kpts vector, each element is a n_bands-by-n_bands matrix.

source
WannierIO.TbDat Type

Container for prefix_tb.dat data.

julia
struct TbDat{T<:Real, IT<:Integer}

Fields

  • header: Header line

  • lattice: Lattice matrix, columns are lattice vectors in Å

  • Rvectors: -vectors on which operators are defined

  • Rdegens: Degeneracies of each -vector

  • H: Hamiltonian matrices

  • r_x: x-component of position operator

  • r_y: y-component of position operator

  • r_z: z-component of position operator

source
WannierIO.read_u_mat Method
julia
read_u_mat(file)

Read wannier90 prefix_u.mat or prefix_u_dis.mat file.

Arguments

  • file: The name of the input file, or an IO.

Return

  • U: Udis (for disentanglement) or U (for maximal localization) matrices

  • kpoints: fractional kpoint coordinates

  • header: 1st line of the file

Warning

The wannier90 output prefix_u_dis.mat internally sorts the band indices according to the disnentanglement window, therefore it can be different from the original Bloch states, see the code and comments in gauge_matrices_dis.

source
WannierIO.write_u_mat Method
julia
write_u_mat(file, U, kpoints; header=default_header())

Write wannier90 prefix_u.mat or prefix_u_dis.mat file.

Arguments

  • file: The name of the output file, or an IO.

  • U: Udis (for disentanglement) or U (for maximal localization) matrices

  • kpoints: fractional kpoint coordinates

Keyword arguments

  • header: 1st line of the file, optional

Warning

The wannier90 output prefix_u_dis.mat internally sorts the band indices according to the disnentanglement window, therefore it can be different from the original Bloch states, see the code and comments in gauge_matrices_dis. This function just writes whatever is inside the input U matrix, without consider the order of disentanglement window.

source
WannierIO._win_block_isend Method

Check if a line marks the end of a named block in a win file.

source
WannierIO._win_block_mustend Method

Assert that a line marks the end of a named block, or raise an error.

source
WannierIO._win_block_nextline Method

Read the next non-empty line from a win file block, with optional case control.

Win files are case-insensitive, but some blocks (e.g., atoms_frac) preserve atomic labels. This function supports both via the :lower kwarg.

source
WannierIO._win_check_line Method

Check if a line starts a block (begins with 'begin ') or contains a key-value pair.

Returns (isblock, content) where content is the block name or key-value line.

source
WannierIO._win_check_required_params Method
julia
_win_check_required_params(kwargs)
source
WannierIO._win_convert_keyval_type Method

Convert a string value to the appropriate type based on value_type symbol.

source
WannierIO._win_convert_keyval_types! Method

Convert all key-value parameter strings to their appropriate types, in-place.

source
WannierIO._win_format_keyval Method

Format a key-value pair for output, handling special types like int3 and indices.

source
WannierIO._win_keyval_types Method

Return a dictionary mapping parameter names to their value types for parsing.

Used to determine how to parse key-value pairs from win files.

source
WannierIO._win_parse_block Method

Dispatch to the appropriate block parser based on the block name.

source
WannierIO._win_parse_block_atoms Method

Parse a atoms_frac or atoms_cart block from a win file.

Returns a vector of (atom_label => fractional/Cartesian coordinates) pairs.

source
WannierIO._win_parse_block_explicit_kpath Method

Parse a explicit_kpath block from a win file.

Returns a vector of k-point coordinates along the path.

source
WannierIO._win_parse_block_explicit_kpath_labels Method

Parse a explicit_kpath_labels block from a win file.

Returns a vector of (label => k-point) pairs for high-symmetry points.

source
WannierIO._win_parse_block_kpoint_path Method

Parse a kpoint_path block from a win file.

Returns a vector of segments, each containing (start_label => start_kpt, end_label => end_kpt) pairs.

source
WannierIO._win_parse_block_kpoints Method

Parse a kpoints block from a win file.

Returns a vector of k-point coordinates.

source
WannierIO._win_parse_block_string Method

Parse a generic block as a vector of strings (for unknown block types).

source
WannierIO._win_parse_block_unit_cell_cart Method

Parse a unit_cell_cart block from a win file.

Returns lattice vectors as a 3×3 matrix (columns are lattice vectors in angstrom).

source
WannierIO._win_parse_keyval Method

Parse a key-value line, separating key and value by = or : delimiters.

source
WannierIO._win_write_block_atoms_cart Method

Write a atoms_cart block to the output.

source
WannierIO._win_write_block_atoms_frac Method

Write a atoms_frac block to the output.

source
WannierIO._win_write_block_explicit_kpath Method

Write a explicit_kpath block to the output.

source
WannierIO._win_write_block_explicit_kpath_labels Method

Write a explicit_kpath_labels block to the output.

source
WannierIO._win_write_block_kpoint_path Method

Write a kpoint_path block to the output.

source
WannierIO._win_write_block_kpoints Method

Write a kpoints block to the output.

source
WannierIO._win_write_block_projections Method

Write a projections block to the output.

source
WannierIO._win_write_block_unit_cell_cart Method

Write a unit_cell_cart block to the output.

source
WannierIO._win_write_comment Method

Write a comment line to the output, prefixing with # if needed.

source
WannierIO._win_write_keyvals Method

Write all key-value parameters to the output stream.

source
WannierIO.standardize_win! Method
julia
standardize_win!(params)

Sanity check and add missing input parameters from a win file.

See also read_win.

source
WannierIO._wout_parse_atoms Method

Parse block

julia
|   Site       Fractional Coordinate          Cartesian Coordinate (Ang)     |
+----------------------------------------------------------------------------+
| Si   1   0.00000   0.00000   0.00000   |    0.00000   0.00000   0.00000    |
| Si   2   0.25000   0.25000   0.25000   |    1.35763   1.35763   1.35763    |
*----------------------------------------------------------------------------*
source
WannierIO._wout_parse_disentangle Method

Parse block

julia
                  Extraction of optimally-connected subspace
                  ------------------------------------------
+---------------------------------------------------------------------+<-- DIS
|  Iter     Omega_I(i-1)      Omega_I(i)      Delta (frac.)    Time   |<-- DIS
+---------------------------------------------------------------------+<-- DIS
      1      25.38943399      21.32896063       1.904E-01      0.00    <-- DIS
      2      21.53095611      20.16097533       6.795E-02      0.01    <-- DIS
      3      20.40788223      19.35260423       5.453E-02      0.01    <-- DIS
      4      19.53883989      18.75563591       4.176E-02      0.02    <-- DIS
...
    341      16.22884440      16.22884440      -1.883E-10      2.43    <-- DIS
    342      16.22884440      16.22884440      -1.799E-10      2.44    <-- DIS

            <<<      Delta < 2.000E-10  over  3 iterations     >>>
            <<< Disentanglement convergence criteria satisfied >>>

        Final Omega_I    16.22884440 (Ang^2)

+----------------------------------------------------------------------------+

Time to disentangle bands      2.546 (sec)
source
WannierIO._wout_parse_final_state Method

See _wout_parse_wf_center_spread for the format of the block to be parsed.

source
WannierIO._wout_parse_im_re_ratio Method

Parse block

julia
      Wannier Function Num:    1       Maximum Im/Re Ratio =    4.566451
      Wannier Function Num:    2       Maximum Im/Re Ratio =    4.566481
      Wannier Function Num:    3       Maximum Im/Re Ratio =    4.566335
      Wannier Function Num:    4       Maximum Im/Re Ratio =    2.154381
source
WannierIO._wout_parse_kgrid Method

Parse line Grid size = 9 x 9 x 9 Total points = 729

source
WannierIO._wout_parse_lattice Method

Parse block

julia
Lattice Vectors (Ang)
a_1     0.000000   2.715265   2.715265
a_2     2.715265   0.000000   2.715265
a_3     2.715265   2.715265   0.000000
source
WannierIO._wout_parse_phase_factor Method

Parse block

julia
      Wannier Function Num:    1       Phase Factor =    0.996157  +0.087588i
      Wannier Function Num:    2       Phase Factor =    0.996157  +0.087588i
      Wannier Function Num:    3       Phase Factor =    0.996157  +0.087588i
      Wannier Function Num:    4       Phase Factor =    0.998869  +0.047543i
source
WannierIO._wout_parse_recip_lattice Method

Parse block

julia
Reciprocal-Space Vectors (Ang^-1)
b_1    -1.157011   1.157011   1.157011
b_2     1.157011  -1.157011   1.157011
b_3     1.157011   1.157011  -1.157011
source
WannierIO._wout_parse_repeated_equals Method

Parse blocks like

julia
      Wannier Function Num:    1       Phase Factor =    0.996157  +0.087588i
      Wannier Function Num:    2       Phase Factor =    0.996157  +0.087588i
      Wannier Function Num:    3       Phase Factor =    0.996157  +0.087588i
      Wannier Function Num:    4       Phase Factor =    0.998869  +0.047543i

or

julia
      Wannier Function Num:    1       Maximum Im/Re Ratio =    4.566451
      Wannier Function Num:    2       Maximum Im/Re Ratio =    4.566481
      Wannier Function Num:    3       Maximum Im/Re Ratio =    4.566335
      Wannier Function Num:    4       Maximum Im/Re Ratio =    2.154381

The line contains the 1st, the remaining lines will be read from io. The last line should be an empty line.

source
WannierIO._wout_parse_wannierize Method

Parse block

julia
*------------------------------- WANNIERISE ---------------------------------*
+--------------------------------------------------------------------+<-- CONV
| Iter  Delta Spread     RMS Gradient      Spread (Ang^2)      Time  |<-- CONV
+--------------------------------------------------------------------+<-- CONV

------------------------------------------------------------------------------
Initial State
 WF centre and spread    1  ( -0.000005,  0.000021,  0.000023 )     2.56218734
 WF centre and spread    2  (  0.000013, -0.000054,  0.000016 )     3.19493515
 WF centre and spread    3  ( -0.000005, -0.000054, -0.000055 )     3.19482997
 WF centre and spread    4  (  0.000012,  0.000015, -0.000058 )     3.19526437
 WF centre and spread    5  (  1.357637,  1.357611,  1.357610 )     2.56218214
 WF centre and spread    6  (  1.357619,  1.357684,  1.357617 )     3.19532825
 WF centre and spread    7  (  1.357638,  1.357687,  1.357686 )     3.19513205
 WF centre and spread    8  (  1.357620,  1.357617,  1.357694 )     3.19460833
 Sum of centres and spreads (  5.430528,  5.430529,  5.430534 )    24.29446759

     0     0.243E+02     0.0000000000       24.2944680346       2.48  <-- CONV
       O_D=      0.2135529 O_OD=      7.8520707 O_TOT=     24.2944680 <-- SPRD
------------------------------------------------------------------------------
Cycle:      1
 WF centre and spread    1  ( -0.000005,  0.000020,  0.000022 )     2.46316318
 WF centre and spread    2  (  0.000014, -0.000057,  0.000015 )     3.19187236
 WF centre and spread    3  ( -0.000005, -0.000057, -0.000058 )     3.19179103
 WF centre and spread    4  (  0.000012,  0.000014, -0.000061 )     3.19222621
 WF centre and spread    5  (  1.357637,  1.357612,  1.357611 )     2.46315800
 WF centre and spread    6  (  1.357618,  1.357687,  1.357618 )     3.19226713
 WF centre and spread    7  (  1.357637,  1.357690,  1.357689 )     3.19209166
 WF centre and spread    8  (  1.357619,  1.357619,  1.357697 )     3.19156919
 Sum of centres and spreads (  5.430528,  5.430529,  5.430534 )    24.07813875

     1    -0.216E+00     0.2558717278       24.0781391952       2.49  <-- CONV
       O_D=      0.2218113 O_OD=      7.6274835 O_TOT=     24.0781392 <-- SPRD
Delta: O_D=  0.8258326E-02 O_OD= -0.2245872E+00 O_TOT= -0.2163288E+00 <-- DLTA
------------------------------------------------------------------------------
Cycle:      2
...
------------------------------------------------------------------------------
Cycle:     45
WF centre and spread    1  (  0.000001,  0.000006,  0.000006 )     1.95373328
WF centre and spread    2  (  0.000016, -0.000065,  0.000019 )     3.27910139
WF centre and spread    3  ( -0.000008, -0.000065, -0.000066 )     3.27921479
WF centre and spread    4  (  0.000014,  0.000016, -0.000070 )     3.27965818
WF centre and spread    5  (  1.357631,  1.357627,  1.357627 )     1.95372427
WF centre and spread    6  (  1.357616,  1.357695,  1.357615 )     3.27949625
WF centre and spread    7  (  1.357641,  1.357699,  1.357697 )     3.27951005
WF centre and spread    8  (  1.357617,  1.357616,  1.357707 )     3.27899768
Sum of centres and spreads (  5.430528,  5.430529,  5.430534 )    23.58343588

   45    -0.186E-09     0.0000077396       23.5834363262       2.88  <-- CONV
      O_D=      0.2612087 O_OD=      7.0933833 O_TOT=     23.5834363 <-- SPRD
Delta: O_D=  0.2557594E-06 O_OD= -0.2559458E-06 O_TOT= -0.1863789E-09 <-- DLTA
------------------------------------------------------------------------------

           <<<     Delta < 2.000E-10  over  3 iterations     >>>
           <<< Wannierisation convergence criteria satisfied >>>
source
WannierIO._wout_parse_wf_center_spread Method

Parse block

julia
WF centre and spread    1  ( -0.000005,  0.000021,  0.000023 )     2.56218734
WF centre and spread    2  (  0.000013, -0.000054,  0.000016 )     3.19493515
WF centre and spread    3  ( -0.000005, -0.000054, -0.000055 )     3.19482997
WF centre and spread    4  (  0.000012,  0.000015, -0.000058 )     3.19526437
WF centre and spread    5  (  1.357637,  1.357611,  1.357610 )     2.56218214
WF centre and spread    6  (  1.357619,  1.357684,  1.357617 )     3.19532825
WF centre and spread    7  (  1.357638,  1.357687,  1.357686 )     3.19513205
WF centre and spread    8  (  1.357620,  1.357617,  1.357694 )     3.19460833
Sum of centres and spreads (  5.430528,  5.430529,  5.430534 )    24.29446759
source
WannierIO._wout_parse_Ω Method

line is the 1st, remaining lines will be read from io.

julia
         Spreads (Ang^2)       Omega I      =     3.956862958
        ================       Omega D      =     0.008030049
                               Omega OD     =     0.501987969
    Final Spread (Ang^2)       Omega Total  =     4.466880976
source
WannierIO.WsvecDat Type

Container for prefix_wsvec.dat data.

julia
struct WsvecDat{IT<:Integer}

Fields

  • header: Header line

  • mdrs: Whether MDRS interpolation is enabled. i.e. the use_ws_distance in the header.

  • Rvectors: The vectors

  • Tvectors: MDRS vectors, or nothing when mdrs == false

  • Tdegens: Degeneracies of MDRS vectors, or nothing when mdrs == false

  • n_wann: Number of Wannier functions

source
WannierIO.WsvecDat Method

For Wigner-Seitz Rvectors, needs to provide a n_wann for number of Wannier functions.

source
WannierIO.WsvecDat Method

For MDRS Rvectors, the n_wann is optional and can be automatically determined from the Tvectors.

source

Page index