mat3ra-esse 2025.4.17.post0__py3-none-any.whl → 2025.5.13.post0__py3-none-any.whl

mat3ra/esse/models/apse/db/nist_jarvis/2024_3.13/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   version:   0.28.5

mat3ra/esse/models/apse/db/nist_jarvis/2024_3.13/atoms.py

@@ -0,0 +1,41 @@
+# generated by datamodel-codegen:
+#   filename:  apse/db/nist_jarvis/2024.3.13/atoms.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field, RootModel
+
+
+class ArrayOf3NumberElementsSchema(RootModel[List[float]]):
+    root: List[float] = Field(..., title="array of 3 number elements schema")
+
+
+class NISTJARVISAtomsSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    lattice_mat: Optional[List[ArrayOf3NumberElementsSchema]] = Field(None, max_length=3, min_length=3)
+    """
+    Crystal lattice vectors as a 3x3 matrix, in Angstroms
+    """
+    coords: Optional[List[ArrayOf3NumberElementsSchema]] = Field(None, min_length=1)
+    """
+    Atomic coordinates for each atom in the unit cell
+    """
+    elements: Optional[List[str]] = Field(None, min_length=1)
+    """
+    Atomic elements for each atom in the unit cell in the same order as `coords`
+    """
+    abc: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="array of 3 number elements schema")
+    angles: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="array of 3 number elements schema")
+    cartesian: Optional[bool] = None
+    """
+    True if the coordinates are in Cartesian space, false if in fractional space
+    """
+    props: Optional[List[str]] = None
+    """
+    Additional properties for each of the atoms
+    """

mat3ra/esse/models/apse/db/nist_jarvis/2024_3.13/db_entry.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  apse/db/nist_jarvis/2024.3.13/db_entry.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field, RootModel
+
+
+class ArrayOf3NumberElementsSchema(RootModel[List[float]]):
+    root: List[float] = Field(..., title="array of 3 number elements schema")
+
+
+class NISTJARVISAtomsSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    lattice_mat: Optional[List[ArrayOf3NumberElementsSchema]] = Field(None, max_length=3, min_length=3)
+    """
+    Crystal lattice vectors as a 3x3 matrix, in Angstroms
+    """
+    coords: Optional[List[ArrayOf3NumberElementsSchema]] = Field(None, min_length=1)
+    """
+    Atomic coordinates for each atom in the unit cell
+    """
+    elements: Optional[List[str]] = Field(None, min_length=1)
+    """
+    Atomic elements for each atom in the unit cell in the same order as `coords`
+    """
+    abc: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="array of 3 number elements schema")
+    angles: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="array of 3 number elements schema")
+    cartesian: Optional[bool] = None
+    """
+    True if the coordinates are in Cartesian space, false if in fractional space
+    """
+    props: Optional[List[str]] = None
+    """
+    Additional properties for each of the atoms
+    """
+
+
+class NISTJARVISDbEntrySchema(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    atoms: Optional[NISTJARVISAtomsSchema] = Field(None, title="NIST JARVIS Atoms schema")
+    """
+    NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571
+    """
+    jid: Optional[str] = None
+    """
+    The id of the entry in the database, e.g. JVASP-677
+    """

mat3ra/esse/models/apse/file/applications/espresso/7.2/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   version:   0.28.5

mat3ra/esse/models/apse/file/applications/espresso/7.2/pw.x/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   version:   0.28.5

mat3ra/esse/models/apse/file/applications/espresso/7.2/pw.x/atomic_positions.py

@@ -0,0 +1,51 @@
+# generated by datamodel-codegen:
+#   filename:  apse/file/applications/espresso/7.2/pw.x/atomic_positions.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field, conint
+
+
+class CardOption(Enum):
+    alat = "alat"
+    bohr = "bohr"
+    angstrom = "angstrom"
+    crystal = "crystal"
+    crystal_sg = "crystal_sg"
+
+
+class Value(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    X: Optional[str] = None
+    """
+    label of the atom as specified in ATOMIC_SPECIES
+    """
+    x: float
+    """
+    atomic positions
+    """
+    y: float
+    """
+    atomic positions
+    """
+    z: float
+    """
+    atomic positions
+    """
+    if_pos_1_: Optional[conint(ge=0, le=1)] = Field(None, alias="if_pos(1)", title="integer one or zero")
+    if_pos_2_: Optional[conint(ge=0, le=1)] = Field(None, alias="if_pos(2)", title="integer one or zero")
+    if_pos_3_: Optional[conint(ge=0, le=1)] = Field(None, alias="if_pos(3)", title="integer one or zero")
+
+
+class AtomicPositionsSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    card_option: Optional[CardOption] = "alat"
+    values: Optional[List[Value]] = None

mat3ra/esse/models/apse/file/applications/espresso/7.2/pw.x/atomic_species.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  apse/file/applications/espresso/7.2/pw.x/atomic_species.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+
+class Value(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    X: Optional[str] = None
+    """
+    label of the atom. Acceptable syntax: chemical symbol X (1 or 2 characters, case-insensitive) or chemical symbol plus a number or a letter, as in "Xn" (e.g. Fe1) or "X_*" or "X-*" (e.g. C1, C_h; max total length cannot exceed 3 characters)
+    """
+    Mass_X: Optional[float] = None
+    """
+    mass of the atomic species [amu: mass of C = 12]. Used only when performing Molecular Dynamics run or structural optimization runs using Damped MD. Not actually used in all other cases (but stored in data files, so phonon calculations will use these values unless other values are provided)
+    """
+    PseudoPot_X: Optional[str] = None
+    """
+    PseudoPot_X
+    """
+
+
+class AtomicSpeciesSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    values: Optional[List[Value]] = None

mat3ra/esse/models/apse/file/applications/espresso/7.2/pw.x/cell.py

@@ -0,0 +1,111 @@
+# generated by datamodel-codegen:
+#   filename:  apse/file/applications/espresso/7.2/pw.x/cell.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional, Union
+
+from pydantic import BaseModel, ConfigDict, Field, RootModel
+
+
+class CellDofree(Enum):
+    all = "all"
+    ibrav = "ibrav"
+    a = "a"
+    b = "b"
+    c = "c"
+    fixa = "fixa"
+    fixb = "fixb"
+    fixc = "fixc"
+    x = "x"
+    y = "y"
+    xy = "xy"
+    xz = "xz"
+    xyz = "xyz"
+    shape = "shape"
+    volume = "volume"
+    field_2Dxy = "2Dxy"
+    field_2Dshape = "2Dshape"
+    epitaxial_ab = "epitaxial_ab"
+    epitaxial_ac = "epitaxial_ac"
+    epitaxial_bc = "epitaxial_bc"
+
+
+class CellDynamics(Enum):
+    none = "none"
+    sd = "sd"
+    damp_pr = "damp-pr"
+    damp_w = "damp-w"
+    bfgs = "bfgs"
+
+
+class CellSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    press: Optional[float] = 0
+    """
+    Target pressure [KBar] in a variable-cell md or relaxation run.
+    """
+    wmass: Optional[float] = None
+    """
+    Fictitious cell mass [amu] for variable-cell simulations (both 'vc-md' and 'vc-relax'). Default: 0.75*Tot_Mass/pi**2 for Parrinello-Rahman MD; 0.75*Tot_Mass/pi**2/Omega**(2/3) for Wentzcovitch MD
+    """
+    cell_factor: Optional[float] = None
+    """
+    Used in the construction of the pseudopotential tables. It should exceed the maximum linear contraction of the cell during a simulation. Default: 2.0 for variable-cell calculations, 1.0 otherwise
+    """
+    press_conv_thr: Optional[float] = 0.5
+    """
+    Convergence threshold on the pressure for variable cell relaxation ('vc-relax' : note that the other convergence thresholds for ionic relaxation apply as well).
+    """
+    cell_dofree: Optional[CellDofree] = "all"
+    """
+    Select which of the cell parameters should be moved
+    """
+    cell_dynamics: Optional[CellDynamics] = "bfgs"
+    """
+    CASE ( calculation == 'vc-relax' )
+    """
+
+
+class CellDynamics1(Enum):
+    none = "none"
+    pr = "pr"
+    w = "w"
+
+
+class CellSchema1(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    press: Optional[float] = 0
+    """
+    Target pressure [KBar] in a variable-cell md or relaxation run.
+    """
+    wmass: Optional[float] = None
+    """
+    Fictitious cell mass [amu] for variable-cell simulations (both 'vc-md' and 'vc-relax'). Default: 0.75*Tot_Mass/pi**2 for Parrinello-Rahman MD; 0.75*Tot_Mass/pi**2/Omega**(2/3) for Wentzcovitch MD
+    """
+    cell_factor: Optional[float] = None
+    """
+    Used in the construction of the pseudopotential tables. It should exceed the maximum linear contraction of the cell during a simulation. Default: 2.0 for variable-cell calculations, 1.0 otherwise
+    """
+    press_conv_thr: Optional[float] = 0.5
+    """
+    Convergence threshold on the pressure for variable cell relaxation ('vc-relax' : note that the other convergence thresholds for ionic relaxation apply as well).
+    """
+    cell_dofree: Optional[CellDofree] = "all"
+    """
+    Select which of the cell parameters should be moved
+    """
+    cell_dynamics: Optional[CellDynamics1] = None
+    """
+    CASE ( calculation == 'vc-md' )
+    """
+
+
+class ESSE(RootModel[Union[CellSchema, CellSchema1]]):
+    root: Union[CellSchema, CellSchema1] = Field(..., title="cell schema")

mat3ra/esse/models/apse/file/applications/espresso/7.2/pw.x/cell_parameters.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  apse/file/applications/espresso/7.2/pw.x/cell_parameters.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class CardOption(Enum):
+    alat = "alat"
+    bohr = "bohr"
+    angstrom = "angstrom"
+
+
+class Values(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    v1: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="array of 3 number elements schema")
+    v2: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="array of 3 number elements schema")
+    v3: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="array of 3 number elements schema")
+
+
+class CellParametersSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    card_option: Optional[CardOption] = None
+    """
+    label of the atom. Acceptable syntax: chemical symbol X (1 or 2 characters, case-insensitive) or chemical symbol plus a number or a letter, as in "Xn" (e.g. Fe1) or "X_*" or "X-*" (e.g. C1, C_h; max total length cannot exceed 3 characters)
+    """
+    values: Optional[Values] = None

mat3ra/esse/models/apse/file/applications/espresso/7.2/pw.x/control.py

@@ -0,0 +1,169 @@
+# generated by datamodel-codegen:
+#   filename:  apse/file/applications/espresso/7.2/pw.x/control.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict
+
+
+class Calculation(Enum):
+    scf = "scf"
+    nscf = "nscf"
+    bands = "bands"
+    relax = "relax"
+    md = "md"
+    vc_relax = "vc-relax"
+    vc_md = "vc-md"
+
+
+class Verbosity(Enum):
+    high = "high"
+    low = "low"
+    debug = "debug"
+    medium = "medium"
+    minimal = "minimal"
+    default = "default"
+
+
+class RestartMode(Enum):
+    from_scratch = "from_scratch"
+    restart = "restart"
+
+
+class DiskIo(Enum):
+    high = "high"
+    medium = "medium"
+    low = "low"
+    nowf = "nowf"
+    none = "none"
+
+
+class ControlSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    calculation: Optional[Calculation] = "scf"
+    """
+    A string describing the task to be performed
+    """
+    title: Optional[str] = ""
+    """
+    reprinted on output.
+    """
+    verbosity: Optional[Verbosity] = "low"
+    """
+    Currently two verbosity levels are implemented: high, low. 'debug' and 'medium' have the same effect as 'high'; 'default' and 'minimal' as 'low'
+    """
+    restart_mode: Optional[RestartMode] = "from_scratch"
+    wf_collect: Optional[bool] = None
+    """
+    OBSOLETE - NO LONGER IMPLEMENTED
+    """
+    nstep: Optional[float] = 1
+    """
+    Default: 1 if calculation == 'scf', 'nscf', 'bands'; 50 for the other cases; Number of molecular-dynamics or structural optimization steps performed in this run. If set to 0, the code performs a quick "dry run", stopping just after initialization. This is useful to check for input correctness and to have the summary printed. NOTE: in MD calculations, the code will perform "nstep" steps even if restarting from a previously interrupted calculation.
+    """
+    iprint: Optional[float] = None
+    """
+    band energies are written every iprint iterations
+    """
+    tstress: Optional[bool] = False
+    """
+    calculate stress. It is set to .TRUE. automatically if calculation == 'vc-md' or 'vc-relax'
+    """
+    tprnfor: Optional[bool] = None
+    """
+    calculate forces. It is set to .TRUE. automatically if calculation == 'relax','md','vc-md'
+    """
+    dt: Optional[float] = 20
+    """
+    time step for molecular dynamics, in Rydberg atomic units (1 a.u.=4.8378 * 10^-17 s : beware, the CP code uses Hartree atomic units, half that much!!!)
+    """
+    outdir: Optional[str] = None
+    """
+    input, temporary, output files are found in this directory, see also wfcdir
+    """
+    wfcdir: Optional[str] = None
+    """
+    This directory specifies where to store files generated by each processor (*.wfc{N}, *.igk{N}, etc.). Useful for machines without a parallel file system: set wfcdir to a local file system, while outdir should be a parallel or network file system, visible to all processors. Beware: in order to restart from interrupted runs, or to perform further calculations using the produced data files, you may need to copy files to outdir. Works only for pw.x.
+    """
+    prefix: Optional[str] = "pwscf"
+    """
+    prepended to input/output filenames: prefix.wfc, prefix.rho, etc.
+    """
+    lkpoint_dir: Optional[bool] = None
+    """
+    OBSOLETE - NO LONGER IMPLEMENTED
+    """
+    max_seconds: Optional[float] = 10000000
+    """
+    Jobs stops after max_seconds CPU time. Use this option in conjunction with option restart_mode if you need to split a job too long to complete into shorter jobs that fit into your batch queues.
+    """
+    etot_conv_thr: Optional[float] = 0.0001
+    """
+    Convergence threshold on total energy (a.u) for ionic minimization: the convergence criterion is satisfied when the total energy changes less than etot_conv_thr between two consecutive scf steps. Note that etot_conv_thr is extensive, like the total energy. See also forc_conv_thr - both criteria must be satisfied
+    """
+    forc_conv_thr: Optional[float] = 0.001
+    """
+    Convergence threshold on forces (a.u) for ionic minimization: the convergence criterion is satisfied when all components of all forces are smaller than forc_conv_thr. See also etot_conv_thr - both criteria must be satisfied
+    """
+    disk_io: Optional[DiskIo] = None
+    """
+    Specifies the amount of disk I/O activity: (only for binary files and xml data file in data directory; other files printed at each molecular dynamics / structural optimization step are not controlled by this option )
+    """
+    pseudo_dir: Optional[str] = None
+    """
+    directory containing pseudopotential files. Default: value of the $ESPRESSO_PSEUDO environment variable if set; '$HOME/espresso/pseudo/' otherwise
+    """
+    tefield: Optional[bool] = False
+    """
+    If .TRUE. a saw-like potential simulating an electric field is added to the bare ionic potential. See variables edir, eamp, emaxpos, eopreg for the form and size of the added potential.
+    """
+    dipfield: Optional[bool] = False
+    """
+    If .TRUE. and tefield==.TRUE. a dipole correction is also added to the bare ionic potential - implements the recipe of L. Bengtsson, PRB 59, 12301 (1999). See variables edir, emaxpos, eopreg for the form of the correction. Must be used ONLY in a slab geometry, for surface calculations, with the discontinuity FALLING IN THE EMPTY SPACE.
+    """
+    lelfield: Optional[bool] = False
+    """
+    If .TRUE. a homogeneous finite electric field described through the modern theory of the polarization is applied. This is different from tefield == .true. !
+    """
+    nberrycyc: Optional[int] = 1
+    """
+    In the case of a finite electric field  ( lelfield == .TRUE. ) it defines the number of iterations for converging the wavefunctions in the electric field Hamiltonian, for each external iteration on the charge density
+    """
+    lorbm: Optional[bool] = False
+    """
+    If .TRUE. perform orbital magnetization calculation.
+    """
+    lberry: Optional[bool] = False
+    """
+    If .TRUE. perform a Berry phase calculation. See the header of PW/src/bp_c_phase.f90 for documentation
+    """
+    gdir: Optional[float] = None
+    """
+    For Berry phase calculation: direction of the k-point strings in reciprocal space. Allowed values: 1, 2, 3 1=first, 2=second, 3=third reciprocal lattice vector For calculations with finite electric fields (lelfield==.true.) "gdir" is the direction of the field.
+    """
+    nppstr: Optional[float] = None
+    """
+    For Berry phase calculation: number of k-points to be calculated along each symmetry-reduced string. The same for calculation with finite electric fields (lelfield==.true.).
+    """
+    gate: Optional[bool] = False
+    """
+    In the case of charged cells (tot_charge .ne. 0) setting gate = .TRUE. represents the counter charge (i.e. -tot_charge) not by a homogeneous background charge but with a charged plate, which is placed at zgate (see below). Details of the gate potential can be found in T. Brumme, M. Calandra, F. Mauri; PRB 89, 245406 (2014). Note, that in systems which are not symmetric with respect to the plate, one needs to enable the dipole correction! (dipfield=.true.). Currently, symmetry can be used with gate=.true. but carefully check that no symmetry is included which maps z to -z even if in principle one could still use them for symmetric systems (i.e. no dipole correction). For nosym=.false. verbosity is set to 'high'. Note: this option was called "monopole" in v6.0 and 6.1 of pw.x
+    """
+    twochem: Optional[bool] = False
+    """
+    IF .TRUE. , a two chemical potential calculation for the simulation of photoexcited systems is performed, constraining a fraction of the electrons in the conduction manifold.
+    """
+    lfcp: Optional[bool] = False
+    """
+    If .TRUE. perform a constant bias potential (constant-mu) calculation for a system with ESM method. See the header of PW/src/fcp_module.f90 for documentation. To perform the calculation, you must set a namelist FCP.
+    """
+    trism: Optional[bool] = False
+    """
+    If .TRUE. perform a 3D-RISM-SCF calculation [for details see H.Sato et al., JCP 112, 9463 (2000), doi:10.1063/1.481564]. The solvent's distributions are calculated by 3D-RISM, though solute is treated as SCF. The charge density and the atomic positions are optimized, simultaneously with the solvents. To perform the calculation, you must set a namelist RISM and a card SOLVENTS. If assume_isolated = 'esm' and esm_bc = 'bc1', Laue-RISM is calculated instead of 3D-RISM and coupled with ESM method (i.e. ESM-RISM). [for details see S.Nishihara and M.Otani, PRB 96, 115429 (2017)]. The default of mixing_beta is 0.2 for both 3D-RISM and Laue-RISM. For structural relaxation with BFGS, ignore_wolfe is always .TRUE. .
+    """

mat3ra/esse/models/apse/file/applications/espresso/7.2/pw.x/electrons.py

@@ -0,0 +1,139 @@
+# generated by datamodel-codegen:
+#   filename:  apse/file/applications/espresso/7.2/pw.x/electrons.json
+#   version:   0.28.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class MixingMode(Enum):
+    plain = "plain"
+    TF = "TF"
+    local_TF = "local-TF"
+
+
+class Diagonalization(Enum):
+    david = "david"
+    cg = "cg"
+    ppcg = "ppcg"
+    paro = "paro"
+    ParO = "ParO"
+    rmm_davidson = "rmm-davidson"
+    rmm_paro = "rmm-paro"
+
+
+class EfieldPhase(Enum):
+    read = "read"
+    write = "write"
+    none = "none"
+
+
+class Startingpot(Enum):
+    atomic = "atomic"
+    file = "file"
+
+
+class Startingwfc(Enum):
+    atomic = "atomic"
+    atomic_random = "atomic+random"
+    random = "random"
+    file = "file"
+
+
+class ElectronsSchema(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    electron_maxstep: Optional[int] = 100
+    """
+    maximum number of iterations in a scf step. If exact exchange is active, this will affect the inner loops.
+    """
+    exx_maxstep: Optional[int] = 100
+    """
+    maximum number of outer iterations in a scf calculation with exact exchange.
+    """
+    scf_must_converge: Optional[bool] = True
+    """
+    If .false. do not stop molecular dynamics or ionic relaxation when electron_maxstep is reached. Use with care.
+    """
+    conv_thr: Optional[float] = None
+    adaptive_thr: Optional[bool] = False
+    """
+    If .TRUE. this turns on the use of an adaptive conv_thr for the inner scf loops when using EXX.
+    """
+    conv_thr_init: Optional[float] = None
+    """
+    When adaptive_thr = .TRUE. this is the convergence threshold used for the first scf cycle.
+    """
+    conv_thr_multi: Optional[float] = None
+    """
+    When adaptive_thr = .TRUE. the convergence threshold for each scf cycle is given by: max( conv_thr, conv_thr_multi * dexx )
+    """
+    mixing_mode: Optional[MixingMode] = "plain"
+    mixing_beta: Optional[float] = None
+    """
+    mixing factor for self-consistency
+    """
+    mixing_ndim: Optional[int] = 8
+    """
+    number of iterations used in mixing scheme
+    """
+    mixing_fixed_ns: Optional[int] = 0
+    """
+    For DFT+U : number of iterations with fixed ns ( ns is the atomic density appearing in the Hubbard term ).
+    """
+    diagonalization: Optional[Diagonalization] = "david"
+    diago_thr_init: Optional[float] = None
+    """
+    Convergence threshold (ethr) for iterative diagonalization (the check is on eigenvalue convergence).
+    """
+    diago_cg_maxiter: Optional[int] = None
+    """
+    For conjugate gradient diagonalization:  max number of iterations
+    """
+    diago_ppcg_maxiter: Optional[int] = None
+    """
+    For ppcg diagonalization:  max number of iterations
+    """
+    diago_david_ndim: Optional[int] = 2
+    """
+    For Davidson diagonalization: dimension of workspace (number of wavefunction packets, at least 2 needed).
+    """
+    diago_rmm_ndim: Optional[int] = 4
+    """
+    For RMM-DIIS diagonalization: dimension of workspace (number of wavefunction packets, at least 2 needed).
+    """
+    diago_rmm_conv: Optional[bool] = False
+    """
+    If .TRUE., RMM-DIIS is performed up to converge. If .FALSE., RMM-DIIS is performed only once.
+    """
+    diago_gs_nblock: Optional[int] = 16
+    """
+    For RMM-DIIS diagonalization: blocking size of Gram-Schmidt orthogonalization
+    """
+    diago_full_acc: Optional[bool] = False
+    """
+    If .TRUE. all the empty states are diagonalized at the same level of accuracy of the occupied ones. Otherwise the empty states are diagonalized using a larger threshold (this should not affect total energy, forces, and other ground-state properties).
+    """
+    efield: Optional[float] = None
+    """
+    Amplitude of the finite electric field (in Ry a.u.; 1 a.u. = 36.3609*10^10 V/m). Used only if lelfield==.TRUE. and if k-points (K_POINTS card) are not automatic.
+    """
+    efield_cart: Optional[List[float]] = Field(
+        None, max_length=3, min_length=3, title="array of 3 number elements schema"
+    )
+    efield_phase: Optional[EfieldPhase] = "none"
+    startingpot: Optional[Startingpot] = None
+    startingwfc: Optional[Startingwfc] = "atomic+random"
+    tqr: Optional[bool] = False
+    """
+    If .true., use a real-space algorithm for augmentation charges of ultrasoft pseudopotentials and PAWsets. Faster but numerically less accurate than the default G-space algorithm. Use with care and after testing!
+    """
+    real_space: Optional[bool] = False
+    """
+    If .true., exploit real-space localization to compute matrix elements for nonlocal projectors. Faster and in principle better scaling than the default G-space algorithm, but numerically less accurate, may lead to some loss of translational invariance. Use with care and after testing!
+    """