ZenGui

ZenGui is a general-purpose graphic user interface for ab initio dynamical mean-field theory codes, which have been developed at the China Academy of Engineeing Physics. It should be used to generate necessary configuration files for them. Now it supports the following codes:

• All-in-one DFT + DMFT package (Zen)
• Dynamical mean-field theory engines (Dyson and DFermion)
• Quantum impurity solver toolkit (iQIST)
• Analytic continuation tools (ACFlow and ACTest)

More codes will be supported in the future. Now this code is under heavy development. PLEASE USE IT AT YOUR OWN RISK.

For more details about how to obtain, install and use this ZenGui app, please visit the following website:

• https://huangli712.github.io/projects/zengui/index.html

Any suggestions, comments, and feedbacks are welcome. Enjoy it!

I32

Alias of Integer type (32 bit).

See also: R32, N32.

I64

Alias of Integer type (64 bit).

See also: R64, N64.

API

Alias of Integer type (Arbitrary Precision Integer).

See also: APF, APC.

F32

Alias of Float type (32 bit).

See also: R32, N32.

F64

Alias of Float type (64 bit).

See also: R64, N64.

APF

Alias of Float type (Arbitrary Precision Float).

See also: API, APC.

C32

Alias of Complex type (32 bit).

See also: R32, N32.

C64

Alias of Complex type (64 bit).

See also: R64, N64.

APC

Alias of Complex type (Arbitrary Precision Complex).

See also: API, APF.

R32

Alias of Integer and Float types (32 bit). Here R means Real.

See also: N32, N64, APN.

R64

Alias of Integer and Float types (64 bit). Here R means Real.

See also: N32, N64, APN.

APR

Alias of Integer and Float types (Arbitrary Precision). Here R means Real.

See also: N32, N64, APN.

N32

Alias of Integer, Float, and Complex types (32 bit). Here N means Number.

See also: R32, R64, APR.

N64

Alias of Integer, Float, and Complex types (64 bit). Here N means Number.

See also: R32, R64, APR.

APN

Alias of Integer, Float, and Complex types (Arbitrary Precision). Here N means Number.

See also: R32, R64, APR.

__LIBNAME__

Name of this julia toolkit.

See also: __VERSION__.

__VERSION__

Version of this julia toolkit.

See also: __RELEASE__.

__RELEASE__

Release date of this julia toolkit.

See also: __AUTHORS__.

__AUTHORS__

Core authors of this julia toolkit.

See also: __LIBNAME__.

authors()

Print authors / contributors of the ZenGui toolkit.

See also: __AUTHORS__.

@cswitch(constexpr, body)

Provides a C-like switch statement with the falling through behavior. This implementation was borrowed from the following github repository:

• https://github.com/Gnimuc/CSyntax.jl

Examples

engine = get_d("engine")
@cswitch engine begin
    @case "vasp"
        just_do_it()
        break

    @default
        sorry()
        break
end

sorry()

Print an error message to the screen.

Arguments

N/A

Returns

N/A

open_url(url::String)

Invoke the default web browser to open the given url. It only supports the windows, macos, and linux systems.

CURRENT_WINDOW

A struct used to keep the name of the current (activate) window. Note that its global instance is CWIN

Members

• name -> Name of the current window.

CWIN

An instance for the CURRENT_WINDOW struct.

See also: CURRENT_WINDOW.

MenuFlags

A struct used to track the status of all the menu items. The renderloop should respond the mouse events according to this struct. Note that its global instance is FMENU

The meun items are created at src/menu.jl.

Members

• F_SAVE -> File | Save.
• F_EXIT -> File | Exit.
• E_ZEN -> Edit | Integrated Package | Zen.
• E_DYSON -> Edit | Quantum Many-Body Theory Engines | Dyson.
• E_DFERMION -> Edit | Quantum Many-Body Theory Engines | DFermion.
• E_CTSEG -> Edit | Quantum Impurity Solvers | iQIST | ctseg.
• E_CTHYB -> Edit | Quantum Impurity Solvers | iQIST | cthyb.
• E_ATOMIC -> Edit | Quantum Impurity Solvers | iQIST | atomic.
• E_ACFLOW -> Edit | Analytic Continuation Tools | ACFlow.
• E_ACTEST -> Edit | Analytic Continuation Tools | ACTest.
• S_BGIMAGE -> Style | Change Background.
• S_CLASSIC -> Style | Classic.
• S_DARK -> Style | Dark.
• S_LIGHT -> Style | Light.
• H_ZEN -> Help | Documentation | Zen.
• H_DYSON -> Help | Documentation | Dyson.
• H_DFERMION -> Help | Documentation | DFermion.
• H_IQIST -> Help | Documentation | iQIST.
• H_ACFLOW -> Help | Documentation | ACFlow.
• H_ACTEST -> Help | Documentation | ACTest.
• H_ZENGUI -> Help | User's Manual.
• H_ABOUT -> Help | About ZenGui.

FMENU

An instance for the MenuFlags struct. Initially, all members are set to be false.

See also: MenuFlags.

create_menu()

Generate all menu items in the main window. Note that the FMENU struct should be modified here.

See also: MenuFlags and FMENU.

set_menu_file()

Setup menu items in ``File''. There are only two items: Save and Exit.

setmenuedit()

Setup menu items in ``Edit''. They are related to the apps developed by myself. Now only the Zen, Dyson, DFermion, iQIST, ACFlow, and ACTest codes are supported.

setmenustyle()

Setup menu items in ``Style''. They are used to modify the appearance, including background image and color styles, of this window-based app.

setmenuhelp()

Setup menu items in ``Help''. They are related to the documentation and user guides of all the apps.

handle_menu_save(p_open::Ref{Bool})

Respond the menu event: save. Try to save configurtion files for various tools or codes.

handle_menu_background(p_open::Ref{Bool})

Respond the menu event: change background. It will change the background image randomly.

See also: setup_background.

handle_menu_dark(p_open::Ref{Bool})

Respond the menu event: dark. Change the appearance of graphic user interface to dark style. Note that the defalt style is dark.

See also: setup_window.

handle_menu_classic(p_open::Ref{Bool})

Respond the menu event: classic. Change the appearance of graphic user interface to classic style.

See also: setup_window.

handle_menu_light(p_open::Ref{Bool})

Respond the menu event: light. Change the appearance of graphic user interface to light style.

See also: setup_window.

handle_menu_zen(p_open::Ref{Bool})

Respond the menu event: zen. Try to open documentation for the Zen package.

handle_menu_dyson(p_open::Ref{Bool})

Respond the menu event: dyson. Try to open documentation for the Dyson code.

handle_menu_dfermion(p_open::Ref{Bool})

Respond the menu event: dfermion. Try to open documentation for the DFermion code.

handle_menu_iqist(p_open::Ref{Bool})

Respond the menu event: iqist. Try to open documentation for the iQIST package.

handle_menu_acflow(p_open::Ref{Bool})

Respond the menu event: acflow. Try to open documentation for the ACFlow toolkit.

handle_menu_actest(p_open::Ref{Bool})

Respond the menu event: actest. Try to open documentation for the ACTest toolkit.

handle_menu_zengui(p_open::Ref{Bool})

Respond the menu event: zengui. Try to open documentation for the ZenGui application.

ZEN_PCASE

This struct represents the [case] block in the case.toml file.

ZEN_PDFT

This struct represents the [dft] block in the case.toml file.

ZEN_PDMFT

This struct represents the [dmft] block in the case.toml file.

ZEN_PIMPURITY

This struct represents the [impurity] block in the case.toml file.

ZEN_PSOLVER

This struct represents the [solver] block in the case.toml file.

PCASE

An instance for the ZEN_PCASE struct.

See also: ZEN_PCASE.

PDFT

An instance for the ZEN_PDFT struct.

See also: ZEN_PDFT.

PDMFT

An instance for the ZEN_PDMFT struct.

See also: ZEN_PDMFT.

PIMPURITY

An instance for the ZEN_PIMPURITY struct.

See also: ZEN_PIMPURITY.

PSOLVER

An instance for the ZEN_PSOLVER struct.

See also: ZEN_PSOLVER.

@widgets_generator_dft

Macro for generating codes for the dft tab.

See also: _zen_dft_block.

@widgets_generator_impurity

Macro for generating codes for the impurity tab.

See also: _zen_impurity_block.

create_app_zen(p_open::Ref{Bool})

Create an UI window for the Zen toolkit, which is an integrated package for ab initio dynamical mean-field theory calculations.

_zen_top_block()

Setup widgets in the top of the window for the Zen package.

_zen_main_block()

Setup widgets associated with the parameters in the case.toml file.

_zen_bottom_block(p_open::Ref{Bool})

Setup widgets in the bottom of the window for the Zen package.

_zen_case_block()

Setup widgets for the case tab.

_zen_dft_block()

Setup widgets for the dft tab.

_zen_dmft_block()

Setup widgets for the dmft tab.

_zen_impurity_block()

Setup widgets for the impurity tab.

_zen_solver_block()

Setup widgets for the solver tab.

build_zen_dict()

Assemble the ordered dictionary, which is then converted into case.toml, for the Zen package.

DYSON_PDYSON

This struct encapsulates the parameters in the dmft.in file.

See also: PDYSON.

_DYSON

This set records the names of modified parameters, which will be presented in the dmft.in file. Note that not all the parameters in DYSON_PDYSON should be presented in the dmft.in file.

See also: DYSON_PDYSON.

PDYSON

An instance for the DYSON_PDYSON struct.

See also: DYSON_PDYSON.

create_app_dyson(p_open::Ref{Bool})

Create an UI window for the Dyson code, which is a dynamical mean-field theory engine.

_dyson_top_block()

Setup widgets in the top of the window for the Dyson code.

_dyson_main_block()

Setup widgets associated with the parameters in the dmft.in file.

_dyson_bottom_block(p_open::Ref{Bool})

Setup widgets in the bottom of the window for the Dyson code.

build_dyson_dict()

Assemble the ordered dictionary, which is then converted into dmft.in, for the Dyson code.

See also: DYSON_PDYSON.

DFERMION_PDFERMION

This struct encapsulates the parameters in the dfa.in file.

See also: PDFERMION.

_DFERMION

This set records the names of modified parameters, which will be presented in the dfa.in file. Note that not all the parameters in DFERMION_PDFERMION should be presented in the dfa.in file.

See also: DFERMION_PDFERMION.

PDFERMION

An instance for the DFERMION_PDFERMION struct.

See also: DFERMION_PDFERMION.

create_app_dfermion(p_open::Ref{Bool})

Create an UI window for the DFermion code, which is a dual fermion engine.

_dfermion_top_block()

Setup widgets in the top of the window for the DFermion code.

_dfermion_main_block()

Setup widgets associated with the parameters in the dfa.in file.

_dfermion_bottom_block(p_open::Ref{Bool})

Setup widgets in the bottom of the window for the DFermion code.

_dfermion_model_block()

Setup widgets for the model tab.

_dfermion_dimension_block()

Setup widgets for the dimension tab.

_dfermion_kmesh_block()

Setup widgets for the k-mesh tab.

_dfermion_cycle_block()

Setup widgets for the cycle tab.

build_dfermion_dict()

Assemble the ordered dictionary, which is then converted into dfa.in, for the DFermion code.

See also: DFERMION_PDFERMION.

IQIST_PCTSEG

This struct encapsulates the parameters in the solver.ctqmc.in file. It is for the iQIST/ctseg code only.

See also: PCTSEG.

IQIST_PCTHYB

This struct encapsulates the parameters in the solver.ctqmc.in file. It is for the iQIST/cthyb code only.

See also: PCTHYB.

IQIST_PATOMIC

This struct encapsulates the parameters in the solver.atomic.in file. It is for the iQIST/atomic code only.

See also: PATOMIC.

_CTSEG

This set records the names of modified parameters, which will be presented in the solver.ctqmc.in file. It is for the iQIST/ctseg code only.

Note that not all the parameters in IQIST_PCTSEG will be presented in the solver.ctqmc.in file.

See also: IQIST_PCTSEG.

_CTHYB

This set records the names of modified parameters, which will be presented in the solver.ctqmc.in file. It is for the iQIST/cthyb code only.

Note that not all the parameters in IQIST_PCTHYB will be presented in the solver.ctqmc.in file.

See also: IQIST_PCTHYB.

_ATOMIC

This set records the names of modified parameters, which will be presented in the solver.atomic.in file. It is for the iQIST/atomic code only.

Note that not all the parameters in IQIST_PATOMIC will be presented in the solver.atomic.in file.

See also: IQIST_PATOMIC.

PCTSEG

An instance for the IQIST_PCTSEG struct.

See also: IQIST_PCTSEG.

PCTHYB

An instance for the IQIST_PCTHYB struct.

See also: IQIST_PCTHYB.

PATOMIC

An instance for the IQIST_PATOMIC struct.

See also: IQIST_PATOMIC.

create_app_ctseg(p_open::Ref{Bool})

Create an UI window for the ctseg code, which is a continuous-time quantum impurity solver in the iQIST package.

create_app_cthyb(p_open::Ref{Bool})

Create an UI window for the cthyb code, which is a continuous-time quantum impurity solver in the iQIST package.

create_app_atomic(p_open::Ref{Bool})

Create an UI window for the atomic code, which is an atomic eigenvalue problem solver in the iQIST package.

_ctseg_top_block()

Setup widgets in the top of the window for the iQIST/ctseg code.

_ctseg_main_block()

Setup widgets associated with the parameters in the solver.ctqmc.in file.

_ctseg_bottom_block(p_open::Ref{Bool})

Setup widgets in the bottom of the window for the iQIST/ctseg code.

_ctseg_model_block()

Setup widgets for the model tab.

_ctseg_dimension_block()

Setup widgets for the dimension tab.

_ctseg_symmetry_block()

Setup widgets for the symmetry tab.

_ctseg_represent_block()

Setup widgets for the representation tab.

_ctseg_measure_block()

Setup widgets for the measurement tab.

_ctseg_monte_block()

Setup widgets for the monte carlo tab.

_ctseg_cycle_block()

Setup widgets for the cycle tab.

_atomic_top_block()

Setup widgets in the top of the window for the iQIST/atomic code.

_atomic_main_block()

Setup widgets associated with the parameters in the solver.atomic.in file.

_atomic_bottom_block(p_open::Ref{Bool})

Setup widgets in the bottom of the window for the iQIST/atomic code.

_atomic_model_block()

Setup widgets for the model tab.

_atomic_interaction_block()

Setup widgets for the interaction tab.

_atomic_natural_block()

Setup widgets for the natural eigenbasis tab.

_atomic_algorithm_block()

Setup widgets for the algorithm tab.

build_iqist_dict()

Assemble the ordered dictionary, which is then converted into solver.ctqmc.in or solver.atomic.in file for the ctseg, cthyb, and atomic codes.

ACFLOW_PBASE

This struct represents the [BASE] block in the ac.toml file.

ACFLOW_PMaxEnt

This struct represents the [MaxEnt] block in the ac.toml file.

ACFLOW_PBarRat

This struct represents the [BarRat] block in the ac.toml file.

ACFLOW_PNevanAC

This struct represents the [NevanAC] block in the ac.toml file.

ACFLOW_PStochAC

This struct represents the [StochAC] block in the ac.toml file.

ACFLOW_PStochSK

This struct represents the [StochSK] block in the ac.toml file.

ACFLOW_PStochOM

This struct represents the [StochOM] block in the ac.toml file.

ACFLOW_PStochPX

This struct represents the [StochPX] block in the ac.toml file.

PBASE

An instance for the ACFLOW_PBASE struct.

See also: ACFLOW_PBASE.

PMaxEnt

An instance for the ACFLOW_PMaxEnt struct.

See also: ACFLOW_PMaxEnt.

PBarRat

An instance for the ACFLOW_PBarRat struct.

See also: ACFLOW_PBarRat.

PNevanAC

An instance for the ACFLOW_PNevanAC struct.

See also: ACFLOW_PNevanAC.

PStochAC

An instance for the ACFLOW_PStochAC struct.

See also: ACFLOW_PStochAC.

PStochSK

An instance for the ACFLOW_PStochSK struct.

See also: ACFLOW_PStochSK.

PStochOM

An instance for the ACFLOW_PStochOM struct.

See also: ACFLOW_PStochOM.

PStochPX

An instance for the ACFLOW_PStochPX struct.

See also: ACFLOW_PStochPX.

create_app_acflow(p_open::Ref{Bool})

Create an UI window for the ACFlow toolkit, which provides some analytic continuation tools.

_acflow_top_block()

Setup widgets in the top of the window for the ACFlow toolkit.

_acflow_main_block()

Setup widgets associated with the parameters in the ac.toml file.

_acflow_bottom_block(p_open::Ref{Bool})

Setup widgets in the bottom of the window for the ACFlow toolkit.

_acflow_general_block()

Setup widgets for the general tab.

_acflow_solver_block()

Setup widgets for the solver tab.

_acflow_maxent_block()

Setup widgets for the [MaxEnt] block in the ac.toml file.

_acflow_barrat_block()

Setup widgets for the [BarRat] block in the ac.toml file.

_acflow_nevanac_block()

Setup widgets for the [NevanAC] block in the ac.toml file.

_acflow_stochac_block()

Setup widgets for the [StochAC] block in the ac.toml file.

_acflow_stochsk_block()

Setup widgets for the [StochSK] block in the ac.toml file.

_acflow_stochom_block()

Setup widgets for the [StochOM] block in the ac.toml file.

_acflow_stochpx_block()

Setup widgets for the [StochPX] block in the ac.toml file.

build_acflow_dict()

Assemble the ordered dictionary, which is then converted into ac.toml, for the ACFlow toolkit.

ACTEST_PTEST

This struct represents the [Test] block in the act.toml file.

PTEST

An instance for the ACTEST_PTEST struct.

See also: ACTEST_PTEST.

create_app_actest(p_open::Ref{Bool})

Create an UI window for the ACTest toolkit, which is used to benchmark the analytic continuation tools as implemented in the ACFlow package.

_actest_top_block()

Setup widgets in the top of the window for the ACTest toolkit.

_actest_main_block()

Setup widgets associated with the parameters in the act.toml file.

_actest_bottom_block(p_open::Ref{Bool})

Setup widgets in the bottom of the window for the ACTest toolkit.

_actest_general_block()

Setup widgets for the general tab.

_actest_solver_block()

Setup widgets for the solver tab.

build_actest_dict()

Assemble the ordered dictionary, which is then converted into act.toml, for the ACTest toolkit.

create_app_about(p_open::Ref{Bool}, logo_id)

Display the About window, which is used to show some userful information about this ZenGui app.

dict_to_toml(d::AbstractDict)

Convert an ordered dictionary to toml file (actually String).

dict_to_ini(d::AbstractDict)

Convert an ordered dictionary to ini file (actually String).

struct_to_dict(s::ZEN_PCASE)

Convert a struct to an ordered dictionary (for ZEN_PCASE).

See ZEN_PCASE.

struct_to_dict(s::ZEN_PDFT)

Convert a struct to an ordered dictionary (for ZEN_PDFT).

See ZEN_PDFT.

struct_to_dict(s::ZEN_PDMFT)

Convert a struct to an ordered dictionary (for ZEN_PDMFT).

See ZEN_PDMFT.

struct_to_dict(s::ZEN_PIMPURITY)

Convert a struct to an ordered dictionary (for ZEN_PIMPURITY).

See ZEN_PIMPURITY.

struct_to_dict(s::ZEN_PSOLVER)

Convert a struct to an ordered dictionary (for ZEN_PSOLVER).

See ZEN_PSOLVER.

struct_to_dict(s::DYSON_PDYSON)

Convert a struct to an ordered dictionary (for DYSON_PDYSON).

See also: DYSON_PDYSON.

struct_to_dict(s::DFERMION_PDFERMION)

Convert a struct to an ordered dictionary (for DFERMION_PDFERMION).

See also: DFERMION_PDFERMION.

struct_to_dict(s::IQIST_PCTSEG)

Convert a struct to an ordered dictionary (for IQIST_PCTSEG).

See IQIST_PCTSEG.

struct_to_dict(s::IQIST_PCTHYB)

Convert a struct to an ordered dictionary (for IQIST_PCTHYB).

See IQIST_PCTHYB.

struct_to_dict(s::IQIST_PATOMIC)

Convert a struct to an ordered dictionary (for IQIST_PATOMIC).

See IQIST_PATOMIC.

struct_to_dict(s::ACFLOW_PBASE)

Convert a struct to an ordered dictionary (for ACFLOW_PBASE).

See ACFLOW_PBASE.

struct_to_dict(s::ACFLOW_PMaxEnt)

Convert a struct to an ordered dictionary (for ACFLOW_PMaxEnt).

See ACFLOW_PMaxEnt.

struct_to_dict(s::ACFLOW_PBarRat)

Convert a struct to an ordered dictionary (for ACFLOW_PBarRat).

See ACFLOW_PBarRat.

struct_to_dict(s::ACFLOW_PNevanAC)

Convert a struct to an ordered dictionary (for ACFLOW_PNevanAC).

See ACFLOW_PNevanAC.

struct_to_dict(s::ACFLOW_PStochAC)

Convert a struct to an ordered dictionary (for ACFLOW_PStochAC).

See ACFLOW_PStochAC.

struct_to_dict(s::ACFLOW_PStochSK)

Convert a struct to an ordered dictionary (for ACFLOW_PStochSK).

See ACFLOW_PStochSK.

struct_to_dict(s::ACFLOW_PStochOM)

Convert a struct to an ordered dictionary (for ACFLOW_PStochOM).

See ACFLOW_PStochOM.

struct_to_dict(s::ACFLOW_PStochPX)

Convert a struct to an ordered dictionary (for ACFLOW_PStochPX).

See ACFLOW_PStochPX.

struct_to_dict(s::ACTEST_PTEST)

Convert a struct to an ordered dictionary (for ACTEST_PTEST).

See ACTEST_PTEST.

load_texture()

Load images from the ZenGui/src/.images directory. Note that there are 12 images now. This function will pick one image randomly and load it. Finally, it will return an ImTextureID object which is associted with the selected image.

See also: setup_background.

load_logo()

Load logo image from the ZenGui/src/.images directory. It will return an ImTextureID object which is associted with the logo image. Note that the logo image will be displayed in the About window.

See also: load_texture.

setup_flags()

Setup configuration flags for the Dear ImGui library.

setup_fonts()

Setup fonts for this graphic user interface. Note that the files for fonts should be saved in the ZenGui/src/.fonts directory.

setup_window()

Tweak the window's style in this graphic user interface.

setup_background(texture_id)

Setup the background image for this app. texture_id is an ImTextureID object. which is initialized by load_texture().

See also: load_texture.

save_zen(p_open::Ref{Bool})

Save configuration file (case.toml) for the Zen package.

save_dyson(p_open::Ref{Bool})

Save configuration file (dmft.in) for the Dyson code.

save_dfermion(p_open::Ref{Bool})

Save configuration file (dfa.in) for the DFermion code.

save_ctseg(p_open::Ref{Bool})

Save configuration file (solver.ctqmc.in) for the iQIST/ctseg code.

save_cthyb(p_open::Ref{Bool})

Save configuration file (solver.ctqmc.in) for the iQIST/cthyb code.

save_atomic(p_open::Ref{Bool})

Save configuration file (solver.atomic.in) for the iQIST/atomic code.

save_acflow(p_open::Ref{Bool})

Save configuration file (ac.toml) for the ACFlow toolkit.

save_actest(p_open::Ref{Bool})

Save configuration file (act.toml) for the ACTest toolkit.

save_nothing(p_open::Ref{Bool})

This function will create an empty window and do nothing.

zeng_run()

Main function. It launchs the graphic user interface and respond to user inputs unitl the main window is closed.