TREXIO Format Support in ElemCo.jl

ElemCo.jl includes support for the TREXIO format, a standardized HDF5-based format for quantum chemistry data exchange. This enables efficient storage and retrieval of orbitals, amplitudes, and other data structures, facilitating interoperability with other quantum chemistry software.

API Reference

Standalone TREXIO Module

ElemCo.TREXIOModule

TREXIO - A standalone Julia implementation of the TREXIO format

This module provides a standalone implementation of the TREXIO format for quantum chemistry data exchange. It follows the TREXIO specification closely and can be used independently of any quantum chemistry package.

TREXIO format specification: https://trex-coe.github.io/trexio/trex.html API documentation: https://trex-coe.github.io/trexio/index.html Reference: https://arxiv.org/pdf/2302.14793

This implementation supports:

  • HDF5 backend for efficient storage
  • Column-major representation as specified by TREXIO
  • Standard TREXIO data groups: nucleus, basis, mo, electron, ao, ecp, grid, amplitude, rdm, qmc
  • Full TREXIO naming convention: trexio[has|read|write]<group>_<attribute>
  • Metadata and versioning
  • Error handling with TREXIO exit codes

The module contains a set of groups/attributes that extend the standard TREXIO format to support additional features and data types. A suppressable warning is issued if the corresponding has/read/write functions are called, and the doc-strings contain warnings as well.

source

TREXIO Core Types and Functions

ElemCo.TREXIO.TrexioFileType
TrexioFile

Structure representing a TREXIO format file following the standard specification. Contains the HDF5 file handle and metadata.

Fields

  • file::HDF5.File: HDF5 file handle
  • filename::String: Path to the TREXIO file
  • mode::String: File access mode ("r", "w", "u")
source
ElemCo.TREXIO.trexio_check_read_statusFunction
trexio_check_read_status(status::TrexioExitCode, what::String="")

Check TREXIO read status and throw error if not successful. what is an optional description of the data being read.

source
ElemCo.TREXIO.trexio_check_write_statusFunction
trexio_check_write_status(status::TrexioExitCode, what::String="")

Check TREXIO write status and throw error if not successful. what is an optional description of the data being written.

source
ElemCo.TREXIO.trexio_closeMethod
trexio_close(trexio::TrexioFile) -> TrexioExitCode

Close a TREXIO file and release resources. Returns TREXIO exit code.

source
ElemCo.TREXIO.trexio_has_amplitude_double_denseMethod
trexio_has_amplitude_double_dense(trexio::TrexioFile) -> Bool

Check if double excitation amplitudes (dense) exists in TREXIO file.

Warning

The function trexio_has_amplitude_double_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_amplitude_double_dndn_denseMethod
trexio_has_amplitude_double_dndn_dense(trexio::TrexioFile) -> Bool

Check if ↓↓-spin component of the double excitation amplitudes (dense) exists in TREXIO file.

Warning

The function trexio_has_amplitude_double_dndn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_amplitude_double_updn_denseMethod
trexio_has_amplitude_double_updn_dense(trexio::TrexioFile) -> Bool

Check if ↑↓-spin component of the double excitation amplitudes (dense) exists in TREXIO file.

Warning

The function trexio_has_amplitude_double_updn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_amplitude_double_upup_denseMethod
trexio_has_amplitude_double_upup_dense(trexio::TrexioFile) -> Bool

Check if ↑↑-spin component of the double excitation amplitudes (dense) exists in TREXIO file.

Warning

The function trexio_has_amplitude_double_upup_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_amplitude_single_denseMethod
trexio_has_amplitude_single_dense(trexio::TrexioFile) -> Bool

Check if single excitation amplitudes (dense) exists in TREXIO file.

Warning

The function trexio_has_amplitude_single_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_amplitude_single_dn_denseMethod
trexio_has_amplitude_single_dn_dense(trexio::TrexioFile) -> Bool

Check if ↓-spin component of the single excitation amplitudes (dense) exists in TREXIO file.

Warning

The function trexio_has_amplitude_single_dn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_amplitude_single_up_denseMethod
trexio_has_amplitude_single_up_dense(trexio::TrexioFile) -> Bool

Check if ↑-spin component of the single excitation amplitudes (dense) exists in TREXIO file.

Warning

The function trexio_has_amplitude_single_up_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_basis_nameMethod
trexio_has_basis_name(trexio::TrexioFile) -> Bool

Check if name of the basis set exists in TREXIO file.

Warning

The function trexio_has_basis_name violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_basis_typeMethod
trexio_has_basis_type(trexio::TrexioFile) -> Bool

Check if type of basis set: "Gaussian", "Slater", "Numerical" or "PW" for plane waves exists in TREXIO file.

source
ElemCo.TREXIO.trexio_has_determinant_alphaMethod
trexio_has_determinant_alpha(trexio::TrexioFile) -> Bool

Check if alpha spin orbital patterns as 64-bit integer bit fields exists in TREXIO file.

Warning

The function trexio_has_determinant_alpha violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_determinant_betaMethod
trexio_has_determinant_beta(trexio::TrexioFile) -> Bool

Check if beta spin orbital patterns as 64-bit integer bit fields exists in TREXIO file.

Warning

The function trexio_has_determinant_beta violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_determinant_n_intMethod
trexio_has_determinant_n_int(trexio::TrexioFile) -> Bool

Check if number of 64-bit integers per spin pattern (ceil(mo.num/64)) exists in TREXIO file.

Warning

The function trexio_has_determinant_n_int violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_ecp_numMethod
trexio_has_ecp_num(trexio::TrexioFile) -> Bool

Check if total number of ECP functions for all atoms and all values of l exists in TREXIO file.

source
ElemCo.TREXIO.trexio_has_mo_typeMethod
trexio_has_mo_type(trexio::TrexioFile) -> Bool

Check if free text to identify the set of MOs (HF, Natural, Local, CASSCF, etc) exists in TREXIO file.

source
ElemCo.TREXIO.trexio_has_po_classMethod
trexio_has_po_class(trexio::TrexioFile) -> Bool

Check if choose among: Core, Inactive, Active, Virtual, Deleted exists in TREXIO file.

Warning

The function trexio_has_po_class violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_coefficientMethod
trexio_has_po_coefficient(trexio::TrexioFile) -> Bool

Check if PO coefficients exists in TREXIO file.

Warning

The function trexio_has_po_coefficient violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_coefficient_imMethod
trexio_has_po_coefficient_im(trexio::TrexioFile) -> Bool

Check if PO coefficients (imaginary part) exists in TREXIO file.

Warning

The function trexio_has_po_coefficient_im violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_energyMethod
trexio_has_po_energy(trexio::TrexioFile) -> Bool

Check if for canonical POs, corresponding eigenvalue exists in TREXIO file.

Warning

The function trexio_has_po_energy violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_k_pointMethod
trexio_has_po_k_point(trexio::TrexioFile) -> Bool

Check if for periodic calculations, the k point to which each PO belongs exists in TREXIO file.

Warning

The function trexio_has_po_k_point violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_numMethod
trexio_has_po_num(trexio::TrexioFile) -> Bool

Check if number of POs exists in TREXIO file.

Warning

The function trexio_has_po_num violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_occupationMethod
trexio_has_po_occupation(trexio::TrexioFile) -> Bool

Check if occupation number exists in TREXIO file.

Warning

The function trexio_has_po_occupation violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_spinMethod
trexio_has_po_spin(trexio::TrexioFile) -> Bool

Check if for UHF wave functions, 0 is ↑ and 1 is ↓ exists in TREXIO file.

Warning

The function trexio_has_po_spin violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_symmetryMethod
trexio_has_po_symmetry(trexio::TrexioFile) -> Bool

Check if symmetry in the point group exists in TREXIO file.

Warning

The function trexio_has_po_symmetry violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_po_typeMethod
trexio_has_po_type(trexio::TrexioFile) -> Bool

Check if free text to identify the set of POs (HF, Natural, Local, CASSCF, etc) exists in TREXIO file.

Warning

The function trexio_has_po_type violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_has_state_file_nameMethod
trexio_has_state_file_name(trexio::TrexioFile) -> Bool

Check if names of the TREXIO files linked to the current one (i.e. containing data for other states) exists in TREXIO file.

source
ElemCo.TREXIO.trexio_openFunction
trexio_open(file_name::String, mode::String="u", back_end=0) -> TrexioFile

Open a TREXIO file for reading or writing. Creates the metadata group structure if opening in write mode. Returns the TrexioFile object or nothing on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_doubleMethod
trexio_read_amplitude_double(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read double excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_double_denseMethod
trexio_read_amplitude_double_dense(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read double excitation amplitudes (dense) from TREXIO file in column-major format (v,v,o(o+1)/2).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_amplitude_double_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_amplitude_double_dndn_denseMethod
trexio_read_amplitude_double_dndn_dense(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read ↓↓-spin component of the double excitation amplitudes (dense) from TREXIO file in column-major format (V(V-1)/2,O(O-1)/2).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_amplitude_double_dndn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_amplitude_double_expMethod
trexio_read_amplitude_double_exp(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read exponentialized double excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_double_updn_denseMethod
trexio_read_amplitude_double_updn_dense(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read ↑↓-spin component of the double excitation amplitudes (dense) from TREXIO file in column-major format (v,V,o,O).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_amplitude_double_updn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_amplitude_double_upup_denseMethod
trexio_read_amplitude_double_upup_dense(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read ↑↑-spin component of the double excitation amplitudes (dense) from TREXIO file in column-major format (v(v-1)/2,o(o-1)/2).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_amplitude_double_upup_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_amplitude_quadrupleMethod
trexio_read_amplitude_quadruple(trexio::TrexioFile) -> (Array{Float64, 8}, TrexioExitCode)

Read quadruple excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_quadruple_expMethod
trexio_read_amplitude_quadruple_exp(trexio::TrexioFile) -> (Array{Float64, 8}, TrexioExitCode)

Read exponentialized quadruple excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_singleMethod
trexio_read_amplitude_single(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read single excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_single_denseMethod
trexio_read_amplitude_single_dense(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read single excitation amplitudes (dense) from TREXIO file in column-major format (v,o).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_amplitude_single_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_amplitude_single_dn_denseMethod
trexio_read_amplitude_single_dn_dense(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read ↓-spin component of the single excitation amplitudes (dense) from TREXIO file in column-major format (V,O).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_amplitude_single_dn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_amplitude_single_expMethod
trexio_read_amplitude_single_exp(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read exponentialized single excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_single_up_denseMethod
trexio_read_amplitude_single_up_dense(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read ↑-spin component of the single excitation amplitudes (dense) from TREXIO file in column-major format (v,o).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_amplitude_single_up_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_amplitude_tripleMethod
trexio_read_amplitude_triple(trexio::TrexioFile) -> (Array{Float64, 6}, TrexioExitCode)

Read triple excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_amplitude_triple_expMethod
trexio_read_amplitude_triple_exp(trexio::TrexioFile) -> (Array{Float64, 6}, TrexioExitCode)

Read exponentialized triple excitation amplitudes from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_core_hamiltonianMethod
trexio_read_ao_1e_int_core_hamiltonian(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read core Hamiltonian integrals ⟨p|h|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_core_hamiltonian_imMethod
trexio_read_ao_1e_int_core_hamiltonian_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read core Hamiltonian integrals ⟨p|h|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_dipole_xMethod
trexio_read_ao_1e_int_dipole_x(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole x component integrals ⟨p|μ_x|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_dipole_x_imMethod
trexio_read_ao_1e_int_dipole_x_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole x component integrals ⟨p|μ_x|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_dipole_yMethod
trexio_read_ao_1e_int_dipole_y(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole y component integrals ⟨p|μ_y|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_dipole_y_imMethod
trexio_read_ao_1e_int_dipole_y_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole y component integrals ⟨p|μ_y|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_dipole_zMethod
trexio_read_ao_1e_int_dipole_z(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole z component integrals ⟨p|μ_z|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_dipole_z_imMethod
trexio_read_ao_1e_int_dipole_z_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole z component integrals ⟨p|μ_z|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_ecpMethod
trexio_read_ao_1e_int_ecp(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read effective core potential integrals ⟨p|V_ECP|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_ecp_imMethod
trexio_read_ao_1e_int_ecp_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read effective core potential integrals ⟨p|V_ECP|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_kineticMethod
trexio_read_ao_1e_int_kinetic(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read kinetic energy integrals ⟨p|T|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_kinetic_imMethod
trexio_read_ao_1e_int_kinetic_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read kinetic energy integrals ⟨p|T|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_overlapMethod
trexio_read_ao_1e_int_overlap(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read overlap integrals ⟨p|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_overlap_imMethod
trexio_read_ao_1e_int_overlap_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read overlap integrals ⟨p|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_potential_n_eMethod
trexio_read_ao_1e_int_potential_n_e(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read electron-nucleus potential integrals ⟨p|V_ne|q⟩ from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_1e_int_potential_n_e_imMethod
trexio_read_ao_1e_int_potential_n_e_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read electron-nucleus potential integrals ⟨p|V_ne|q⟩ (imaginary part) from TREXIO file in column-major format (ao.num,ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_2e_int_eriMethod
trexio_read_ao_2e_int_eri(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read electron repulsion integrals ⟨pq|rs⟩ from TREXIO file in column-major format (ao.num,ao.num,ao.num,ao.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_2e_int_eri_choleskyMethod
trexio_read_ao_2e_int_eri_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the ERI from TREXIO file in column-major format (ao.num,ao.num,ao2eint.ericholeskynum) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_2e_int_eri_cholesky_numMethod
trexio_read_ao_2e_int_eri_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors for ERI from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_2e_int_eri_lrMethod
trexio_read_ao_2e_int_eri_lr(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read long-range electron repulsion integrals from TREXIO file in column-major format (ao.num,ao.num,ao.num,ao.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_2e_int_eri_lr_choleskyMethod
trexio_read_ao_2e_int_eri_lr_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the long range ERI from TREXIO file in column-major format (ao.num,ao.num,ao2eint.erilrcholesky_num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_2e_int_eri_lr_cholesky_numMethod
trexio_read_ao_2e_int_eri_lr_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors for long range ERI from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_cartesianMethod
trexio_read_ao_cartesian(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read 1: true, 0: false from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_normalizationMethod
trexio_read_ao_normalization(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read normalization factor N'_i from TREXIO file in vector format (ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_numMethod
trexio_read_ao_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read total number of atomic orbitals from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ao_shellMethod
trexio_read_ao_shell(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read basis set shell for each AO from TREXIO file in vector format (ao.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_coefficientMethod
trexio_read_basis_coefficient(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read coefficients of the primitives (aks) from TREXIO file in vector format (basis.primnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_coefficient_imMethod
trexio_read_basis_coefficient_im(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read imaginary part of the coefficients of the primitives (aks) from TREXIO file in vector format (basis.primnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_e_cutMethod
trexio_read_basis_e_cut(trexio::TrexioFile) -> (Float64, TrexioExitCode)

Read energy cut-off for plane-wave calculations from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_exponentMethod
trexio_read_basis_exponent(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read exponents of the primitives (\gammaks) from TREXIO file in vector format (basis.primnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_exponent_imMethod
trexio_read_basis_exponent_im(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read imaginary part of the exponents of the primitives (\gammaks) from TREXIO file in vector format (basis.primnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_interp_coeff_cntMethod
trexio_read_basis_interp_coeff_cnt(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of coefficients for the numerical orbital interpolator from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_interpolator_gradMethod
trexio_read_basis_interpolator_grad(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read coefficients for numerical orbital gradient interpolation function from TREXIO file in column-major format (basis.interpcoeffcnt,basis.naogridnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_interpolator_kindMethod
trexio_read_basis_interpolator_kind(trexio::TrexioFile) -> (String, TrexioExitCode)

Read Kind of spline, e.g. "Polynomial" from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_interpolator_lapMethod
trexio_read_basis_interpolator_lap(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read coefficients for numerical orbital laplacian interpolation function from TREXIO file in column-major format (basis.interpcoeffcnt,basis.naogridnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_interpolator_phiMethod
trexio_read_basis_interpolator_phi(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read coefficients for numerical orbital interpolation function from TREXIO file in column-major format (basis.interpcoeffcnt,basis.naogridnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nameMethod
trexio_read_basis_name(trexio::TrexioFile) -> (String, TrexioExitCode)

Read name of the basis set from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_basis_name violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_basis_nao_grid_gradMethod
trexio_read_basis_nao_grid_grad(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read radial gradient of numerical orbitals from TREXIO file in vector format (basis.naogridnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nao_grid_lapMethod
trexio_read_basis_nao_grid_lap(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read Laplacian of numerical orbitals from TREXIO file in vector format (basis.naogridnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nao_grid_numMethod
trexio_read_basis_nao_grid_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read total number of grid points for numerical orbitals from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nao_grid_phiMethod
trexio_read_basis_nao_grid_phi(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read wave function values for numerical orbitals from TREXIO file in vector format (basis.naogridnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nao_grid_radiusMethod
trexio_read_basis_nao_grid_radius(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read radii of grid points for numerical orbitals from TREXIO file in vector format (basis.naogridnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nao_grid_sizeMethod
trexio_read_basis_nao_grid_size(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read number of data points per numerical orbital from TREXIO file in vector format (basis.shell_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nao_grid_startMethod
trexio_read_basis_nao_grid_start(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read index of the first data point for a given numerical orbital from TREXIO file in vector format (basis.shell_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_nucleus_indexMethod
trexio_read_basis_nucleus_index(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read one-to-one correspondence between shells and atomic indices from TREXIO file in vector format (basis.shell_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_oscillation_argMethod
trexio_read_basis_oscillation_arg(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read additional argument to have oscillating orbitals (\betaks) from TREXIO file in vector format (basis.primnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_oscillation_kindMethod
trexio_read_basis_oscillation_kind(trexio::TrexioFile) -> (String, TrexioExitCode)

Read kind of oscillating function: "Cos1" or "Cos2" from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_prim_factorMethod
trexio_read_basis_prim_factor(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read normalization coefficients for the primitives (fks) from TREXIO file in vector format (basis.primnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_prim_numMethod
trexio_read_basis_prim_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read total number of primitives from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_r_powerMethod
trexio_read_basis_r_power(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read power to which r is raised (Ns) from TREXIO file in vector format (basis.shellnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_shell_ang_momMethod
trexio_read_basis_shell_ang_mom(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read one-to-one correspondence between shells and angular momenta from TREXIO file in vector format (basis.shell_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_shell_factorMethod
trexio_read_basis_shell_factor(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read normalization factor for each shell (Ns) from TREXIO file in vector format (basis.shellnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_shell_indexMethod
trexio_read_basis_shell_index(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read one-to-one correspondence between primitives and shell index from TREXIO file in vector format (basis.prim_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_shell_numMethod
trexio_read_basis_shell_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read total number of shells from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_basis_typeMethod
trexio_read_basis_type(trexio::TrexioFile) -> (String, TrexioExitCode)

Read type of basis set: "Gaussian", "Slater", "Numerical" or "PW" for plane waves from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_cell_aMethod
trexio_read_cell_a(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read first real space lattice vector from TREXIO file in vector format (3).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_cell_bMethod
trexio_read_cell_b(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read second real space lattice vector from TREXIO file in vector format (3).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_cell_cMethod
trexio_read_cell_c(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read third real space lattice vector from TREXIO file in vector format (3).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_cell_g_aMethod
trexio_read_cell_g_a(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read first reciprocal space lattice vector from TREXIO file in vector format (3).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_cell_g_bMethod
trexio_read_cell_g_b(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read second reciprocal space lattice vector from TREXIO file in vector format (3).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_cell_g_cMethod
trexio_read_cell_g_c(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read third reciprocal space lattice vector from TREXIO file in vector format (3).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_cell_two_piMethod
trexio_read_cell_two_pi(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read 0 or 1; if two_pi=1, 2π is included in the reciprocal vectors from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_csf_coefficientMethod
trexio_read_csf_coefficient(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read coefficients of the CSF expansion from TREXIO file in vector format (csf.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_csf_det_coefficientMethod
trexio_read_csf_det_coefficient(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read projection on the determinant basis from TREXIO file in column-major format (determinant.num,csf.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_csf_numMethod
trexio_read_csf_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of CSFs from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_determinant_alphaMethod
trexio_read_determinant_alpha(trexio::TrexioFile) -> (Matrix{Int64}, TrexioExitCode)

Read alpha spin orbital patterns as 64-bit integer bit fields from TREXIO file in column-major format (determinant.n_int,determinant.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_determinant_alpha violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_determinant_betaMethod
trexio_read_determinant_beta(trexio::TrexioFile) -> (Matrix{Int64}, TrexioExitCode)

Read beta spin orbital patterns as 64-bit integer bit fields from TREXIO file in column-major format (determinant.n_int,determinant.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_determinant_beta violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_determinant_coefficientMethod
trexio_read_determinant_coefficient(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read coefficients of the determinants from the CI expansion from TREXIO file in vector format (determinant.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_determinant_listMethod
trexio_read_determinant_list(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read list of determinants as integer bit fields from TREXIO file in vector format (determinant.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_determinant_n_intMethod
trexio_read_determinant_n_int(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of 64-bit integers per spin pattern (ceil(mo.num/64)) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_determinant_n_int violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_determinant_numMethod
trexio_read_determinant_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of determinants from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_ang_momMethod
trexio_read_ecp_ang_mom(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read one-to-one correspondence between ECP items and the angular momentum l from TREXIO file in vector format (ecp.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_coefficientMethod
trexio_read_ecp_coefficient(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read all ECP coefficients βAql from TREXIO file in vector format (ecp.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_exponentMethod
trexio_read_ecp_exponent(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read all ECP exponents αAql from TREXIO file in vector format (ecp.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_max_ang_mom_plus_1Method
trexio_read_ecp_max_ang_mom_plus_1(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read l_max+1, one higher than the max angular momentum in the removed core orbitals from TREXIO file in vector format (nucleus.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_nucleus_indexMethod
trexio_read_ecp_nucleus_index(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read one-to-one correspondence between ECP items and the atom index from TREXIO file in vector format (ecp.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_numMethod
trexio_read_ecp_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read total number of ECP functions for all atoms and all values of l from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_powerMethod
trexio_read_ecp_power(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read all ECP powers nAql from TREXIO file in vector format (ecp.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_ecp_z_coreMethod
trexio_read_ecp_z_core(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read number of core electrons to remove per atom from TREXIO file in vector format (nucleus.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_electron_dn_numMethod
trexio_read_electron_dn_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of spin-down electrons from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_electron_numMethod
trexio_read_electron_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of electrons from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_electron_up_numMethod
trexio_read_electron_up_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of spin-up electrons from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_ang_coordMethod
trexio_read_grid_ang_coord(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read discretized angular space (if used) from TREXIO file in vector format (grid.ang_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_ang_numMethod
trexio_read_grid_ang_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of angular integration points (if used) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_ang_weightMethod
trexio_read_grid_ang_weight(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read angular grid weights (if used) from TREXIO file in vector format (grid.ang_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_coordMethod
trexio_read_grid_coord(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read discretized coordinate space from TREXIO file in vector format (grid.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_descriptionMethod
trexio_read_grid_description(trexio::TrexioFile) -> (String, TrexioExitCode)

Read details about the used quadratures can go here from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_max_ang_numMethod
trexio_read_grid_max_ang_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read maximum number of angular grid points (for pruning) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_min_ang_numMethod
trexio_read_grid_min_ang_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read minimum number of angular grid points (for pruning) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_numMethod
trexio_read_grid_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of grid points from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_rad_coordMethod
trexio_read_grid_rad_coord(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read discretized radial space (if used) from TREXIO file in vector format (grid.rad_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_rad_numMethod
trexio_read_grid_rad_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of radial integration points (if used) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_rad_precisionMethod
trexio_read_grid_rad_precision(trexio::TrexioFile) -> (Float64, TrexioExitCode)

Read radial precision parameter (not used in some schemes like Krack-Köster) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_rad_weightMethod
trexio_read_grid_rad_weight(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read radial grid weights (if used) from TREXIO file in vector format (grid.rad_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_grid_weightMethod
trexio_read_grid_weight(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read grid weights according to a given partitioning (e.g. Becke) from TREXIO file in vector format (grid.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_eeMethod
trexio_read_jastrow_ee(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read electron-electron parameters from TREXIO file in vector format (jastrow.ee_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_ee_numMethod
trexio_read_jastrow_ee_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Electron-electron parameters from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_ee_scalingMethod
trexio_read_jastrow_ee_scaling(trexio::TrexioFile) -> (Float64, TrexioExitCode)

Read κ_ee value in CHAMP Jastrow for electron-electron distances from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_eenMethod
trexio_read_jastrow_een(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read electron-electron-nucleus parameters from TREXIO file in vector format (jastrow.een_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_een_nucleusMethod
trexio_read_jastrow_een_nucleus(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read nucleus relative to the eeN parameter from TREXIO file in vector format (jastrow.een_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_een_numMethod
trexio_read_jastrow_een_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Electron-electron-nucleus parameters from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_enMethod
trexio_read_jastrow_en(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read electron-nucleus parameters from TREXIO file in vector format (jastrow.en_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_en_nucleusMethod
trexio_read_jastrow_en_nucleus(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read nucleus relative to the eN parameter from TREXIO file in vector format (jastrow.en_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_en_numMethod
trexio_read_jastrow_en_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Electron-nucleus parameters from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_en_scalingMethod
trexio_read_jastrow_en_scaling(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read κ_α value in CHAMP Jastrow for electron-nucleus distances from TREXIO file in vector format (nucleus.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_jastrow_typeMethod
trexio_read_jastrow_type(trexio::TrexioFile) -> (String, TrexioExitCode)

Read type of Jastrow factor: CHAMP or Mu from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_metadata_authorMethod
trexio_read_metadata_author(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read names of the authors of the file from TREXIO file in vector format (metadata.author_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_metadata_author_numMethod
trexio_read_metadata_author_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of authors of the file from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_metadata_codeMethod
trexio_read_metadata_code(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read names of the codes used from TREXIO file in vector format (metadata.code_num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_metadata_code_numMethod
trexio_read_metadata_code_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of codes used to produce the file from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_metadata_descriptionMethod
trexio_read_metadata_description(trexio::TrexioFile) -> (String, TrexioExitCode)

Read text describing the content of file from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_metadata_package_versionMethod
trexio_read_metadata_package_version(trexio::TrexioFile) -> (String, TrexioExitCode)

Read TREXIO version used to produce the file from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_metadata_unsafeMethod
trexio_read_metadata_unsafe(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read indicates whether the file has been previously opened with 'u' mode; 1: true, 0: false from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_core_hamiltonianMethod
trexio_read_mo_1e_int_core_hamiltonian(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read core Hamiltonian integrals ⟨p|h|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_core_hamiltonian_imMethod
trexio_read_mo_1e_int_core_hamiltonian_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read core Hamiltonian integrals ⟨p|h|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_dipole_xMethod
trexio_read_mo_1e_int_dipole_x(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole x component integrals ⟨p|μ_x|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_dipole_x_imMethod
trexio_read_mo_1e_int_dipole_x_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole x component integrals ⟨p|μ_x|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_dipole_yMethod
trexio_read_mo_1e_int_dipole_y(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole y component integrals ⟨p|μ_y|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_dipole_y_imMethod
trexio_read_mo_1e_int_dipole_y_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole y component integrals ⟨p|μ_y|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_dipole_zMethod
trexio_read_mo_1e_int_dipole_z(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole z component integrals ⟨p|μ_z|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_dipole_z_imMethod
trexio_read_mo_1e_int_dipole_z_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read dipole z component integrals ⟨p|μ_z|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_ecpMethod
trexio_read_mo_1e_int_ecp(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read effective core potential integrals ⟨p|V_ECP|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_ecp_imMethod
trexio_read_mo_1e_int_ecp_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read effective core potential integrals ⟨p|V_ECP|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_kineticMethod
trexio_read_mo_1e_int_kinetic(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read kinetic energy integrals ⟨p|T|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_kinetic_imMethod
trexio_read_mo_1e_int_kinetic_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read kinetic energy integrals ⟨p|T|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_overlapMethod
trexio_read_mo_1e_int_overlap(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read overlap integrals ⟨p|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_overlap_imMethod
trexio_read_mo_1e_int_overlap_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read overlap integrals ⟨p|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_potential_n_eMethod
trexio_read_mo_1e_int_potential_n_e(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read electron-nucleus potential integrals ⟨p|V_ne|q⟩ from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_1e_int_potential_n_e_imMethod
trexio_read_mo_1e_int_potential_n_e_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read electron-nucleus potential integrals ⟨p|V_ne|q⟩ (imaginary part) from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_2e_int_eriMethod
trexio_read_mo_2e_int_eri(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read electron repulsion integrals ⟨pq|rs⟩ from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_2e_int_eri_choleskyMethod
trexio_read_mo_2e_int_eri_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the ERI from TREXIO file in column-major format (mo.num,mo.num,mo2eint.ericholeskynum) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_2e_int_eri_cholesky_numMethod
trexio_read_mo_2e_int_eri_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors for ERI from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_2e_int_eri_lrMethod
trexio_read_mo_2e_int_eri_lr(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read long-range electron repulsion integrals from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_2e_int_eri_lr_choleskyMethod
trexio_read_mo_2e_int_eri_lr_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the long range ERI from TREXIO file in column-major format (mo.num,mo.num,mo2eint.erilrcholesky_num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_2e_int_eri_lr_cholesky_numMethod
trexio_read_mo_2e_int_eri_lr_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors for long range ERI from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_classMethod
trexio_read_mo_class(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read choose among: Core, Inactive, Active, Virtual, Deleted from TREXIO file in vector format (mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_coefficientMethod
trexio_read_mo_coefficient(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read MO coefficients from TREXIO file in column-major format (ao.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_coefficient_imMethod
trexio_read_mo_coefficient_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read MO coefficients (imaginary part) from TREXIO file in column-major format (ao.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_energyMethod
trexio_read_mo_energy(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read for canonical MOs, corresponding eigenvalue from TREXIO file in vector format (mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_k_pointMethod
trexio_read_mo_k_point(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read for periodic calculations, the k point to which each MO belongs from TREXIO file in vector format (mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_numMethod
trexio_read_mo_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of MOs from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_occupationMethod
trexio_read_mo_occupation(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read occupation number from TREXIO file in vector format (mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_spinMethod
trexio_read_mo_spin(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read for UHF wave functions, 0 is ↑ and 1 is ↓ from TREXIO file in vector format (mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_symmetryMethod
trexio_read_mo_symmetry(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read symmetry in the point group from TREXIO file in vector format (mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_mo_typeMethod
trexio_read_mo_type(trexio::TrexioFile) -> (String, TrexioExitCode)

Read free text to identify the set of MOs (HF, Natural, Local, CASSCF, etc) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_nucleus_chargeMethod
trexio_read_nucleus_charge(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read charges of the nuclei from TREXIO file in vector format (nucleus.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_nucleus_coordMethod
trexio_read_nucleus_coord(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read coordinates of the atoms from TREXIO file in column-major format (3,nucleus.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_nucleus_labelMethod
trexio_read_nucleus_label(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read atom labels from TREXIO file in vector format (nucleus.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_nucleus_numMethod
trexio_read_nucleus_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of nuclei from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_nucleus_point_groupMethod
trexio_read_nucleus_point_group(trexio::TrexioFile) -> (String, TrexioExitCode)

Read symmetry point group from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_nucleus_repulsionMethod
trexio_read_nucleus_repulsion(trexio::TrexioFile) -> (Float64, TrexioExitCode)

Read nuclear repulsion energy from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_pbc_k_pointMethod
trexio_read_pbc_k_point(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read k-point sampling from TREXIO file in column-major format (3,pbc.kpointnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_pbc_k_point_numMethod
trexio_read_pbc_k_point_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of k-points from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_pbc_k_point_weightMethod
trexio_read_pbc_k_point_weight(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read k-point weights from TREXIO file in vector format (pbc.kpointnum).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_pbc_madelungMethod
trexio_read_pbc_madelung(trexio::TrexioFile) -> (Float64, TrexioExitCode)

Read Madelung correction of the Ewald probe charge method from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_pbc_periodicMethod
trexio_read_pbc_periodic(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read 1: true or 0: false from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_po_classMethod
trexio_read_po_class(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read choose among: Core, Inactive, Active, Virtual, Deleted from TREXIO file in vector format (po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_class violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_coefficientMethod
trexio_read_po_coefficient(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read PO coefficients from TREXIO file in column-major format (ao.num,po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_coefficient violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_coefficient_imMethod
trexio_read_po_coefficient_im(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read PO coefficients (imaginary part) from TREXIO file in column-major format (ao.num,po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_coefficient_im violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_energyMethod
trexio_read_po_energy(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read for canonical POs, corresponding eigenvalue from TREXIO file in vector format (po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_energy violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_k_pointMethod
trexio_read_po_k_point(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read for periodic calculations, the k point to which each PO belongs from TREXIO file in vector format (po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_k_point violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_numMethod
trexio_read_po_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of POs from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_num violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_occupationMethod
trexio_read_po_occupation(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read occupation number from TREXIO file in vector format (po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_occupation violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_spinMethod
trexio_read_po_spin(trexio::TrexioFile) -> (Vector{Int64}, TrexioExitCode)

Read for UHF wave functions, 0 is ↑ and 1 is ↓ from TREXIO file in vector format (po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_spin violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_symmetryMethod
trexio_read_po_symmetry(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read symmetry in the point group from TREXIO file in vector format (po.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_symmetry violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_po_typeMethod
trexio_read_po_type(trexio::TrexioFile) -> (String, TrexioExitCode)

Read free text to identify the set of POs (HF, Natural, Local, CASSCF, etc) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

Warning

The function trexio_read_po_type violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_read_qmc_e_locMethod
trexio_read_qmc_e_loc(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read local energy evaluated at the points from TREXIO file in vector format (qmc.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_qmc_numMethod
trexio_read_qmc_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of 3N-dimensional points from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_qmc_pointMethod
trexio_read_qmc_point(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read 3N-dimensional points from TREXIO file in column-major format (3,electron.num,qmc.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_qmc_psiMethod
trexio_read_qmc_psi(trexio::TrexioFile) -> (Vector{Float64}, TrexioExitCode)

Read wave function evaluated at the points from TREXIO file in vector format (qmc.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_1eMethod
trexio_read_rdm_1e(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read one body density matrix from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_1e_dnMethod
trexio_read_rdm_1e_dn(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read ↓-spin component of the one body density matrix from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_1e_transitionMethod
trexio_read_rdm_1e_transition(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read one-particle transition density matrices from TREXIO file in column-major format (mo.num,mo.num,state.num,state.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_1e_upMethod
trexio_read_rdm_1e_up(trexio::TrexioFile) -> (Matrix{Float64}, TrexioExitCode)

Read ↑-spin component of the one body density matrix from TREXIO file in column-major format (mo.num,mo.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2eMethod
trexio_read_rdm_2e(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read two-body reduced density matrix (spin trace) from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_choleskyMethod
trexio_read_rdm_2e_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the two-body RDM (spin trace) from TREXIO file in column-major format (mo.num,mo.num,rdm.2echoleskynum) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_cholesky_numMethod
trexio_read_rdm_2e_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_dndnMethod
trexio_read_rdm_2e_dndn(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read ↓↓ component of the two-body reduced density matrix from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_dndn_choleskyMethod
trexio_read_rdm_2e_dndn_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the two-body RDM (↓↓) from TREXIO file in column-major format (mo.num,mo.num,rdm.2edndncholesky_num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_dndn_cholesky_numMethod
trexio_read_rdm_2e_dndn_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_transitionMethod
trexio_read_rdm_2e_transition(trexio::TrexioFile) -> (Array{Float64, 6}, TrexioExitCode)

Read two-particle transition density matrices from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,state.num,state.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_updnMethod
trexio_read_rdm_2e_updn(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read ↑↓ component of the two-body reduced density matrix from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_updn_choleskyMethod
trexio_read_rdm_2e_updn_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the two-body RDM (↑↓) from TREXIO file in column-major format (mo.num,mo.num,rdm.2eupdncholesky_num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_updn_cholesky_numMethod
trexio_read_rdm_2e_updn_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_upupMethod
trexio_read_rdm_2e_upup(trexio::TrexioFile) -> (Array{Float64, 4}, TrexioExitCode)

Read ↑↑ component of the two-body reduced density matrix from TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_upup_choleskyMethod
trexio_read_rdm_2e_upup_cholesky(trexio::TrexioFile) -> (Array{Float64, 3}, TrexioExitCode)

Read Cholesky decomposition of the two-body RDM (↑↑) from TREXIO file in column-major format (mo.num,mo.num,rdm.2eupupcholesky_num) (sparse).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_rdm_2e_upup_cholesky_numMethod
trexio_read_rdm_2e_upup_cholesky_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of Cholesky vectors from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_state_current_labelMethod
trexio_read_state_current_label(trexio::TrexioFile) -> (String, TrexioExitCode)

Read label of the current state from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_state_energyMethod
trexio_read_state_energy(trexio::TrexioFile) -> (Float64, TrexioExitCode)

Read energy of the current state from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_state_file_nameMethod
trexio_read_state_file_name(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read names of the TREXIO files linked to the current one (i.e. containing data for other states) from TREXIO file in vector format (state.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_state_idMethod
trexio_read_state_id(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read index of the current state (0 is ground state) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_state_labelMethod
trexio_read_state_label(trexio::TrexioFile) -> (Vector{String}, TrexioExitCode)

Read labels of all states from TREXIO file in vector format (state.num).

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_read_state_numMethod
trexio_read_state_num(trexio::TrexioFile) -> (Int64, TrexioExitCode)

Read number of states (including the ground state) from TREXIO file.

Returns (dummy_info, TREXIO_HAS_NOT) if not present, or (dummy_info, error_code) on failure.

source
ElemCo.TREXIO.trexio_write_amplitude_doubleMethod
trexio_write_amplitude_double(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write double excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_amplitude_double_denseMethod
trexio_write_amplitude_double_dense(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write double excitation amplitudes (dense) to TREXIO file in column-major format (v,v,o(o+1)/2).

Warning

The function trexio_write_amplitude_double_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_amplitude_double_dndn_denseMethod
trexio_write_amplitude_double_dndn_dense(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write ↓↓-spin component of the double excitation amplitudes (dense) to TREXIO file in column-major format (V(V-1)/2,O(O-1)/2).

Warning

The function trexio_write_amplitude_double_dndn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_amplitude_double_expMethod
trexio_write_amplitude_double_exp(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write exponentialized double excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_amplitude_double_updn_denseMethod
trexio_write_amplitude_double_updn_dense(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write ↑↓-spin component of the double excitation amplitudes (dense) to TREXIO file in column-major format (v,V,o,O).

Warning

The function trexio_write_amplitude_double_updn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_amplitude_double_upup_denseMethod
trexio_write_amplitude_double_upup_dense(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write ↑↑-spin component of the double excitation amplitudes (dense) to TREXIO file in column-major format (v(v-1)/2,o(o-1)/2).

Warning

The function trexio_write_amplitude_double_upup_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_amplitude_quadrupleMethod
trexio_write_amplitude_quadruple(trexio::TrexioFile, value::Array{Float64, 8}) -> TrexioExitCode

Write quadruple excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_amplitude_quadruple_expMethod
trexio_write_amplitude_quadruple_exp(trexio::TrexioFile, value::Array{Float64, 8}) -> TrexioExitCode

Write exponentialized quadruple excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_amplitude_singleMethod
trexio_write_amplitude_single(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write single excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_amplitude_single_denseMethod
trexio_write_amplitude_single_dense(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write single excitation amplitudes (dense) to TREXIO file in column-major format (v,o).

Warning

The function trexio_write_amplitude_single_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_amplitude_single_dn_denseMethod
trexio_write_amplitude_single_dn_dense(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write ↓-spin component of the single excitation amplitudes (dense) to TREXIO file in column-major format (V,O).

Warning

The function trexio_write_amplitude_single_dn_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_amplitude_single_expMethod
trexio_write_amplitude_single_exp(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write exponentialized single excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_amplitude_single_up_denseMethod
trexio_write_amplitude_single_up_dense(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write ↑-spin component of the single excitation amplitudes (dense) to TREXIO file in column-major format (v,o).

Warning

The function trexio_write_amplitude_single_up_dense violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_amplitude_tripleMethod
trexio_write_amplitude_triple(trexio::TrexioFile, value::Array{Float64, 6}) -> TrexioExitCode

Write triple excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_amplitude_triple_expMethod
trexio_write_amplitude_triple_exp(trexio::TrexioFile, value::Array{Float64, 6}) -> TrexioExitCode

Write exponentialized triple excitation amplitudes to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_dipole_xMethod
trexio_write_ao_1e_int_dipole_x(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole x component integrals ⟨p|μ_x|q⟩ to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_dipole_x_imMethod
trexio_write_ao_1e_int_dipole_x_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole x component integrals ⟨p|μ_x|q⟩ (imaginary part) to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_dipole_yMethod
trexio_write_ao_1e_int_dipole_y(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole y component integrals ⟨p|μ_y|q⟩ to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_dipole_y_imMethod
trexio_write_ao_1e_int_dipole_y_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole y component integrals ⟨p|μ_y|q⟩ (imaginary part) to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_dipole_zMethod
trexio_write_ao_1e_int_dipole_z(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole z component integrals ⟨p|μ_z|q⟩ to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_dipole_z_imMethod
trexio_write_ao_1e_int_dipole_z_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole z component integrals ⟨p|μ_z|q⟩ (imaginary part) to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_ecpMethod
trexio_write_ao_1e_int_ecp(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write effective core potential integrals ⟨p|V_ECP|q⟩ to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_ecp_imMethod
trexio_write_ao_1e_int_ecp_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write effective core potential integrals ⟨p|V_ECP|q⟩ (imaginary part) to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_kineticMethod
trexio_write_ao_1e_int_kinetic(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write kinetic energy integrals ⟨p|T|q⟩ to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_kinetic_imMethod
trexio_write_ao_1e_int_kinetic_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write kinetic energy integrals ⟨p|T|q⟩ (imaginary part) to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_overlap_imMethod
trexio_write_ao_1e_int_overlap_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write overlap integrals ⟨p|q⟩ (imaginary part) to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_1e_int_potential_n_e_imMethod
trexio_write_ao_1e_int_potential_n_e_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write electron-nucleus potential integrals ⟨p|V_ne|q⟩ (imaginary part) to TREXIO file in column-major format (ao.num,ao.num).

source
ElemCo.TREXIO.trexio_write_ao_2e_int_eriMethod
trexio_write_ao_2e_int_eri(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write electron repulsion integrals ⟨pq|rs⟩ to TREXIO file in column-major format (ao.num,ao.num,ao.num,ao.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_ao_2e_int_eri_choleskyMethod
trexio_write_ao_2e_int_eri_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the ERI to TREXIO file in column-major format (ao.num,ao.num,ao2eint.ericholeskynum) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_ao_2e_int_eri_lrMethod
trexio_write_ao_2e_int_eri_lr(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write long-range electron repulsion integrals to TREXIO file in column-major format (ao.num,ao.num,ao.num,ao.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_ao_2e_int_eri_lr_choleskyMethod
trexio_write_ao_2e_int_eri_lr_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the long range ERI to TREXIO file in column-major format (ao.num,ao.num,ao2eint.erilrcholesky_num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_ao_numMethod
trexio_write_ao_num(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write total number of atomic orbitals to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_ao_shellMethod
trexio_write_ao_shell(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write basis set shell for each AO to TREXIO file as vector of Int64 values (ao.num).

source
ElemCo.TREXIO.trexio_write_basis_coefficientMethod
trexio_write_basis_coefficient(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write coefficients of the primitives (aks) to TREXIO file as vector of Float64 values (basis.primnum).

source
ElemCo.TREXIO.trexio_write_basis_coefficient_imMethod
trexio_write_basis_coefficient_im(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write imaginary part of the coefficients of the primitives (aks) to TREXIO file as vector of Float64 values (basis.primnum).

source
ElemCo.TREXIO.trexio_write_basis_e_cutMethod
trexio_write_basis_e_cut(trexio::TrexioFile, value::Float64) -> TrexioExitCode

Write energy cut-off for plane-wave calculations to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_basis_exponentMethod
trexio_write_basis_exponent(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write exponents of the primitives (\gammaks) to TREXIO file as vector of Float64 values (basis.primnum).

source
ElemCo.TREXIO.trexio_write_basis_exponent_imMethod
trexio_write_basis_exponent_im(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write imaginary part of the exponents of the primitives (\gammaks) to TREXIO file as vector of Float64 values (basis.primnum).

source
ElemCo.TREXIO.trexio_write_basis_interpolator_gradMethod
trexio_write_basis_interpolator_grad(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write coefficients for numerical orbital gradient interpolation function to TREXIO file in column-major format (basis.interpcoeffcnt,basis.naogridnum).

source
ElemCo.TREXIO.trexio_write_basis_interpolator_lapMethod
trexio_write_basis_interpolator_lap(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write coefficients for numerical orbital laplacian interpolation function to TREXIO file in column-major format (basis.interpcoeffcnt,basis.naogridnum).

source
ElemCo.TREXIO.trexio_write_basis_interpolator_phiMethod
trexio_write_basis_interpolator_phi(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write coefficients for numerical orbital interpolation function to TREXIO file in column-major format (basis.interpcoeffcnt,basis.naogridnum).

source
ElemCo.TREXIO.trexio_write_basis_nameMethod
trexio_write_basis_name(trexio::TrexioFile, value::String) -> TrexioExitCode

Write name of the basis set to TREXIO file stored as HDF5 attribute.

Warning

The function trexio_write_basis_name violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_basis_nao_grid_gradMethod
trexio_write_basis_nao_grid_grad(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write radial gradient of numerical orbitals to TREXIO file as vector of Float64 values (basis.naogridnum).

source
ElemCo.TREXIO.trexio_write_basis_nao_grid_lapMethod
trexio_write_basis_nao_grid_lap(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write Laplacian of numerical orbitals to TREXIO file as vector of Float64 values (basis.naogridnum).

source
ElemCo.TREXIO.trexio_write_basis_nao_grid_phiMethod
trexio_write_basis_nao_grid_phi(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write wave function values for numerical orbitals to TREXIO file as vector of Float64 values (basis.naogridnum).

source
ElemCo.TREXIO.trexio_write_basis_nao_grid_radiusMethod
trexio_write_basis_nao_grid_radius(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write radii of grid points for numerical orbitals to TREXIO file as vector of Float64 values (basis.naogridnum).

source
ElemCo.TREXIO.trexio_write_basis_nao_grid_sizeMethod
trexio_write_basis_nao_grid_size(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write number of data points per numerical orbital to TREXIO file as vector of Int64 values (basis.shell_num).

source
ElemCo.TREXIO.trexio_write_basis_nao_grid_startMethod
trexio_write_basis_nao_grid_start(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write index of the first data point for a given numerical orbital to TREXIO file as vector of Int64 values (basis.shell_num).

source
ElemCo.TREXIO.trexio_write_basis_nucleus_indexMethod
trexio_write_basis_nucleus_index(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write one-to-one correspondence between shells and atomic indices to TREXIO file as vector of Int64 values (basis.shell_num).

source
ElemCo.TREXIO.trexio_write_basis_oscillation_argMethod
trexio_write_basis_oscillation_arg(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write additional argument to have oscillating orbitals (\betaks) to TREXIO file as vector of Float64 values (basis.primnum).

source
ElemCo.TREXIO.trexio_write_basis_prim_factorMethod
trexio_write_basis_prim_factor(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write normalization coefficients for the primitives (fks) to TREXIO file as vector of Float64 values (basis.primnum).

source
ElemCo.TREXIO.trexio_write_basis_r_powerMethod
trexio_write_basis_r_power(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write power to which r is raised (Ns) to TREXIO file as vector of Int64 values (basis.shellnum).

source
ElemCo.TREXIO.trexio_write_basis_shell_ang_momMethod
trexio_write_basis_shell_ang_mom(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write one-to-one correspondence between shells and angular momenta to TREXIO file as vector of Int64 values (basis.shell_num).

source
ElemCo.TREXIO.trexio_write_basis_shell_factorMethod
trexio_write_basis_shell_factor(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write normalization factor for each shell (Ns) to TREXIO file as vector of Float64 values (basis.shellnum).

source
ElemCo.TREXIO.trexio_write_basis_shell_indexMethod
trexio_write_basis_shell_index(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write one-to-one correspondence between primitives and shell index to TREXIO file as vector of Int64 values (basis.prim_num).

source
ElemCo.TREXIO.trexio_write_basis_typeMethod
trexio_write_basis_type(trexio::TrexioFile, value::String) -> TrexioExitCode

Write type of basis set: "Gaussian", "Slater", "Numerical" or "PW" for plane waves to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_cell_aMethod
trexio_write_cell_a(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write first real space lattice vector to TREXIO file as vector of Float64 values (3).

source
ElemCo.TREXIO.trexio_write_cell_bMethod
trexio_write_cell_b(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write second real space lattice vector to TREXIO file as vector of Float64 values (3).

source
ElemCo.TREXIO.trexio_write_cell_cMethod
trexio_write_cell_c(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write third real space lattice vector to TREXIO file as vector of Float64 values (3).

source
ElemCo.TREXIO.trexio_write_cell_g_aMethod
trexio_write_cell_g_a(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write first reciprocal space lattice vector to TREXIO file as vector of Float64 values (3).

source
ElemCo.TREXIO.trexio_write_cell_g_bMethod
trexio_write_cell_g_b(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write second reciprocal space lattice vector to TREXIO file as vector of Float64 values (3).

source
ElemCo.TREXIO.trexio_write_cell_g_cMethod
trexio_write_cell_g_c(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write third reciprocal space lattice vector to TREXIO file as vector of Float64 values (3).

source
ElemCo.TREXIO.trexio_write_cell_two_piMethod
trexio_write_cell_two_pi(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write 0 or 1; if two_pi=1, 2π is included in the reciprocal vectors to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_csf_coefficientMethod
trexio_write_csf_coefficient(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write coefficients of the CSF expansion to TREXIO file as vector of Float64 values (csf.num).

source
ElemCo.TREXIO.trexio_write_csf_det_coefficientMethod
trexio_write_csf_det_coefficient(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write projection on the determinant basis to TREXIO file in column-major format (determinant.num,csf.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_determinant_alphaMethod
trexio_write_determinant_alpha(trexio::TrexioFile, value::Array{Int64, 2}) -> TrexioExitCode

Write alpha spin orbital patterns as 64-bit integer bit fields to TREXIO file in column-major format (determinant.n_int,determinant.num).

Warning

The function trexio_write_determinant_alpha violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_determinant_betaMethod
trexio_write_determinant_beta(trexio::TrexioFile, value::Array{Int64, 2}) -> TrexioExitCode

Write beta spin orbital patterns as 64-bit integer bit fields to TREXIO file in column-major format (determinant.n_int,determinant.num).

Warning

The function trexio_write_determinant_beta violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_determinant_coefficientMethod
trexio_write_determinant_coefficient(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write coefficients of the determinants from the CI expansion to TREXIO file as vector of Float64 values (determinant.num).

source
ElemCo.TREXIO.trexio_write_determinant_listMethod
trexio_write_determinant_list(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write list of determinants as integer bit fields to TREXIO file as vector of Int64 values (determinant.num).

source
ElemCo.TREXIO.trexio_write_determinant_n_intMethod
trexio_write_determinant_n_int(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write number of 64-bit integers per spin pattern (ceil(mo.num/64)) to TREXIO file stored as HDF5 attribute.

Warning

The function trexio_write_determinant_n_int violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_ecp_ang_momMethod
trexio_write_ecp_ang_mom(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write one-to-one correspondence between ECP items and the angular momentum l to TREXIO file as vector of Int64 values (ecp.num).

source
ElemCo.TREXIO.trexio_write_ecp_exponentMethod
trexio_write_ecp_exponent(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write all ECP exponents αAql to TREXIO file as vector of Float64 values (ecp.num).

source
ElemCo.TREXIO.trexio_write_ecp_max_ang_mom_plus_1Method
trexio_write_ecp_max_ang_mom_plus_1(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write l_max+1, one higher than the max angular momentum in the removed core orbitals to TREXIO file as vector of Int64 values (nucleus.num).

source
ElemCo.TREXIO.trexio_write_ecp_nucleus_indexMethod
trexio_write_ecp_nucleus_index(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write one-to-one correspondence between ECP items and the atom index to TREXIO file as vector of Int64 values (ecp.num).

source
ElemCo.TREXIO.trexio_write_ecp_numMethod
trexio_write_ecp_num(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write total number of ECP functions for all atoms and all values of l to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_ecp_powerMethod
trexio_write_ecp_power(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write all ECP powers nAql to TREXIO file as vector of Int64 values (ecp.num).

source
ElemCo.TREXIO.trexio_write_ecp_z_coreMethod
trexio_write_ecp_z_core(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write number of core electrons to remove per atom to TREXIO file as vector of Int64 values (nucleus.num).

source
ElemCo.TREXIO.trexio_write_grid_ang_coordMethod
trexio_write_grid_ang_coord(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write discretized angular space (if used) to TREXIO file as vector of Float64 values (grid.ang_num).

source
ElemCo.TREXIO.trexio_write_grid_ang_numMethod
trexio_write_grid_ang_num(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write number of angular integration points (if used) to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_grid_ang_weightMethod
trexio_write_grid_ang_weight(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write angular grid weights (if used) to TREXIO file as vector of Float64 values (grid.ang_num).

source
ElemCo.TREXIO.trexio_write_grid_coordMethod
trexio_write_grid_coord(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write discretized coordinate space to TREXIO file as vector of Float64 values (grid.num).

source
ElemCo.TREXIO.trexio_write_grid_rad_coordMethod
trexio_write_grid_rad_coord(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write discretized radial space (if used) to TREXIO file as vector of Float64 values (grid.rad_num).

source
ElemCo.TREXIO.trexio_write_grid_rad_numMethod
trexio_write_grid_rad_num(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write number of radial integration points (if used) to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_grid_rad_precisionMethod
trexio_write_grid_rad_precision(trexio::TrexioFile, value::Float64) -> TrexioExitCode

Write radial precision parameter (not used in some schemes like Krack-Köster) to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_grid_rad_weightMethod
trexio_write_grid_rad_weight(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write radial grid weights (if used) to TREXIO file as vector of Float64 values (grid.rad_num).

source
ElemCo.TREXIO.trexio_write_grid_weightMethod
trexio_write_grid_weight(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write grid weights according to a given partitioning (e.g. Becke) to TREXIO file as vector of Float64 values (grid.num).

source
ElemCo.TREXIO.trexio_write_jastrow_eeMethod
trexio_write_jastrow_ee(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write electron-electron parameters to TREXIO file as vector of Float64 values (jastrow.ee_num).

source
ElemCo.TREXIO.trexio_write_jastrow_eenMethod
trexio_write_jastrow_een(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write electron-electron-nucleus parameters to TREXIO file as vector of Float64 values (jastrow.een_num).

source
ElemCo.TREXIO.trexio_write_jastrow_enMethod
trexio_write_jastrow_en(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write electron-nucleus parameters to TREXIO file as vector of Float64 values (jastrow.en_num).

source
ElemCo.TREXIO.trexio_write_jastrow_en_scalingMethod
trexio_write_jastrow_en_scaling(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write κ_α value in CHAMP Jastrow for electron-nucleus distances to TREXIO file as vector of Float64 values (nucleus.num).

source
ElemCo.TREXIO.trexio_write_metadata_authorMethod
trexio_write_metadata_author(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write names of the authors of the file to TREXIO file as vector of String values (metadata.author_num).

source
ElemCo.TREXIO.trexio_write_metadata_codeMethod
trexio_write_metadata_code(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write names of the codes used to TREXIO file as vector of String values (metadata.code_num).

source
ElemCo.TREXIO.trexio_write_metadata_unsafeMethod
trexio_write_metadata_unsafe(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write indicates whether the file has been previously opened with 'u' mode; 1: true, 0: false to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_mo_1e_int_dipole_xMethod
trexio_write_mo_1e_int_dipole_x(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole x component integrals ⟨p|μ_x|q⟩ to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_dipole_x_imMethod
trexio_write_mo_1e_int_dipole_x_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole x component integrals ⟨p|μ_x|q⟩ (imaginary part) to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_dipole_yMethod
trexio_write_mo_1e_int_dipole_y(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole y component integrals ⟨p|μ_y|q⟩ to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_dipole_y_imMethod
trexio_write_mo_1e_int_dipole_y_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole y component integrals ⟨p|μ_y|q⟩ (imaginary part) to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_dipole_zMethod
trexio_write_mo_1e_int_dipole_z(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole z component integrals ⟨p|μ_z|q⟩ to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_dipole_z_imMethod
trexio_write_mo_1e_int_dipole_z_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write dipole z component integrals ⟨p|μ_z|q⟩ (imaginary part) to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_ecpMethod
trexio_write_mo_1e_int_ecp(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write effective core potential integrals ⟨p|V_ECP|q⟩ to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_ecp_imMethod
trexio_write_mo_1e_int_ecp_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write effective core potential integrals ⟨p|V_ECP|q⟩ (imaginary part) to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_kineticMethod
trexio_write_mo_1e_int_kinetic(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write kinetic energy integrals ⟨p|T|q⟩ to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_kinetic_imMethod
trexio_write_mo_1e_int_kinetic_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write kinetic energy integrals ⟨p|T|q⟩ (imaginary part) to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_overlap_imMethod
trexio_write_mo_1e_int_overlap_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write overlap integrals ⟨p|q⟩ (imaginary part) to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_1e_int_potential_n_e_imMethod
trexio_write_mo_1e_int_potential_n_e_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write electron-nucleus potential integrals ⟨p|V_ne|q⟩ (imaginary part) to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_mo_2e_int_eriMethod
trexio_write_mo_2e_int_eri(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write electron repulsion integrals ⟨pq|rs⟩ to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_mo_2e_int_eri_choleskyMethod
trexio_write_mo_2e_int_eri_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the ERI to TREXIO file in column-major format (mo.num,mo.num,mo2eint.ericholeskynum) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_mo_2e_int_eri_lrMethod
trexio_write_mo_2e_int_eri_lr(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write long-range electron repulsion integrals to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_mo_2e_int_eri_lr_choleskyMethod
trexio_write_mo_2e_int_eri_lr_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the long range ERI to TREXIO file in column-major format (mo.num,mo.num,mo2eint.erilrcholesky_num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_mo_classMethod
trexio_write_mo_class(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write choose among: Core, Inactive, Active, Virtual, Deleted to TREXIO file as vector of String values (mo.num).

source
ElemCo.TREXIO.trexio_write_mo_energyMethod
trexio_write_mo_energy(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write for canonical MOs, corresponding eigenvalue to TREXIO file as vector of Float64 values (mo.num).

source
ElemCo.TREXIO.trexio_write_mo_k_pointMethod
trexio_write_mo_k_point(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write for periodic calculations, the k point to which each MO belongs to TREXIO file as vector of Int64 values (mo.num).

source
ElemCo.TREXIO.trexio_write_mo_spinMethod
trexio_write_mo_spin(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write for UHF wave functions, 0 is ↑ and 1 is ↓ to TREXIO file as vector of Int64 values (mo.num).

source
ElemCo.TREXIO.trexio_write_mo_symmetryMethod
trexio_write_mo_symmetry(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write symmetry in the point group to TREXIO file as vector of String values (mo.num).

source
ElemCo.TREXIO.trexio_write_mo_typeMethod
trexio_write_mo_type(trexio::TrexioFile, value::String) -> TrexioExitCode

Write free text to identify the set of MOs (HF, Natural, Local, CASSCF, etc) to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_nucleus_coordMethod
trexio_write_nucleus_coord(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write coordinates of the atoms to TREXIO file in column-major format (3,nucleus.num).

source
ElemCo.TREXIO.trexio_write_pbc_k_pointMethod
trexio_write_pbc_k_point(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write k-point sampling to TREXIO file in column-major format (3,pbc.kpointnum).

source
ElemCo.TREXIO.trexio_write_pbc_madelungMethod
trexio_write_pbc_madelung(trexio::TrexioFile, value::Float64) -> TrexioExitCode

Write Madelung correction of the Ewald probe charge method to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_po_classMethod
trexio_write_po_class(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write choose among: Core, Inactive, Active, Virtual, Deleted to TREXIO file as vector of String values (po.num).

Warning

The function trexio_write_po_class violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_coefficientMethod
trexio_write_po_coefficient(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write PO coefficients to TREXIO file in column-major format (ao.num,po.num).

Warning

The function trexio_write_po_coefficient violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_coefficient_imMethod
trexio_write_po_coefficient_im(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write PO coefficients (imaginary part) to TREXIO file in column-major format (ao.num,po.num).

Warning

The function trexio_write_po_coefficient_im violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_energyMethod
trexio_write_po_energy(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write for canonical POs, corresponding eigenvalue to TREXIO file as vector of Float64 values (po.num).

Warning

The function trexio_write_po_energy violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_k_pointMethod
trexio_write_po_k_point(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write for periodic calculations, the k point to which each PO belongs to TREXIO file as vector of Int64 values (po.num).

Warning

The function trexio_write_po_k_point violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_numMethod
trexio_write_po_num(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write number of POs to TREXIO file stored as HDF5 attribute.

Warning

The function trexio_write_po_num violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_occupationMethod
trexio_write_po_occupation(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write occupation number to TREXIO file as vector of Float64 values (po.num).

Warning

The function trexio_write_po_occupation violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_spinMethod
trexio_write_po_spin(trexio::TrexioFile, value::Vector{Int64}) -> TrexioExitCode

Write for UHF wave functions, 0 is ↑ and 1 is ↓ to TREXIO file as vector of Int64 values (po.num).

Warning

The function trexio_write_po_spin violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_symmetryMethod
trexio_write_po_symmetry(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write symmetry in the point group to TREXIO file as vector of String values (po.num).

Warning

The function trexio_write_po_symmetry violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_po_typeMethod
trexio_write_po_type(trexio::TrexioFile, value::String) -> TrexioExitCode

Write free text to identify the set of POs (HF, Natural, Local, CASSCF, etc) to TREXIO file stored as HDF5 attribute.

Warning

The function trexio_write_po_type violates the TREXIO standard.

source
ElemCo.TREXIO.trexio_write_qmc_e_locMethod
trexio_write_qmc_e_loc(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write local energy evaluated at the points to TREXIO file as vector of Float64 values (qmc.num).

source
ElemCo.TREXIO.trexio_write_qmc_numMethod
trexio_write_qmc_num(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write number of 3N-dimensional points to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_qmc_pointMethod
trexio_write_qmc_point(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write 3N-dimensional points to TREXIO file in column-major format (3,electron.num,qmc.num).

source
ElemCo.TREXIO.trexio_write_qmc_psiMethod
trexio_write_qmc_psi(trexio::TrexioFile, value::Vector{Float64}) -> TrexioExitCode

Write wave function evaluated at the points to TREXIO file as vector of Float64 values (qmc.num).

source
ElemCo.TREXIO.trexio_write_rdm_1eMethod
trexio_write_rdm_1e(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write one body density matrix to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_rdm_1e_dnMethod
trexio_write_rdm_1e_dn(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write ↓-spin component of the one body density matrix to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_rdm_1e_transitionMethod
trexio_write_rdm_1e_transition(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write one-particle transition density matrices to TREXIO file in column-major format (mo.num,mo.num,state.num,state.num).

source
ElemCo.TREXIO.trexio_write_rdm_1e_upMethod
trexio_write_rdm_1e_up(trexio::TrexioFile, value::Array{Float64, 2}) -> TrexioExitCode

Write ↑-spin component of the one body density matrix to TREXIO file in column-major format (mo.num,mo.num).

source
ElemCo.TREXIO.trexio_write_rdm_2eMethod
trexio_write_rdm_2e(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write two-body reduced density matrix (spin trace) to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_choleskyMethod
trexio_write_rdm_2e_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the two-body RDM (spin trace) to TREXIO file in column-major format (mo.num,mo.num,rdm.2echoleskynum) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_dndnMethod
trexio_write_rdm_2e_dndn(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write ↓↓ component of the two-body reduced density matrix to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_dndn_choleskyMethod
trexio_write_rdm_2e_dndn_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the two-body RDM (↓↓) to TREXIO file in column-major format (mo.num,mo.num,rdm.2edndncholesky_num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_transitionMethod
trexio_write_rdm_2e_transition(trexio::TrexioFile, value::Array{Float64, 6}) -> TrexioExitCode

Write two-particle transition density matrices to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num,state.num,state.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_updnMethod
trexio_write_rdm_2e_updn(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write ↑↓ component of the two-body reduced density matrix to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_updn_choleskyMethod
trexio_write_rdm_2e_updn_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the two-body RDM (↑↓) to TREXIO file in column-major format (mo.num,mo.num,rdm.2eupdncholesky_num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_upupMethod
trexio_write_rdm_2e_upup(trexio::TrexioFile, value::Array{Float64, 4}) -> TrexioExitCode

Write ↑↑ component of the two-body reduced density matrix to TREXIO file in column-major format (mo.num,mo.num,mo.num,mo.num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_rdm_2e_upup_choleskyMethod
trexio_write_rdm_2e_upup_cholesky(trexio::TrexioFile, value::Array{Float64, 3}) -> TrexioExitCode

Write Cholesky decomposition of the two-body RDM (↑↑) to TREXIO file in column-major format (mo.num,mo.num,rdm.2eupupcholesky_num) (sparse: indices/values format).

source
ElemCo.TREXIO.trexio_write_state_file_nameMethod
trexio_write_state_file_name(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write names of the TREXIO files linked to the current one (i.e. containing data for other states) to TREXIO file as vector of String values (state.num).

source
ElemCo.TREXIO.trexio_write_state_idMethod
trexio_write_state_id(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write index of the current state (0 is ground state) to TREXIO file stored as HDF5 attribute.

source
ElemCo.TREXIO.trexio_write_state_labelMethod
trexio_write_state_label(trexio::TrexioFile, value::Vector{String}) -> TrexioExitCode

Write labels of all states to TREXIO file as vector of String values (state.num).

source
ElemCo.TREXIO.trexio_write_state_numMethod
trexio_write_state_num(trexio::TrexioFile, value::Int64) -> TrexioExitCode

Write number of states (including the ground state) to TREXIO file stored as HDF5 attribute.

source

TrexioInterface Module

ElemCo.TrexioInterfaceModule

TREXIO Interface Module for ElemCo.jl

This module provides ElemCo-specific functions to import and export data in TREXIO format, which is a standardized format for quantum chemistry data exchange. It uses the standalone TREXIO module for core operations and provides convenient conversion between ElemCo types and TREXIO standard formats.

TREXIO format specification:

  • Based on HDF5 for efficient storage
  • Standardized structure for quantum chemistry data
  • Supports orbitals, amplitudes, integrals, and other QC data

See: https://trexio-coe.github.io/trexio/lib.html https://arxiv.org/abs/2302.14793

source

ElemCo Integration Functions

ElemCo.TrexioInterface.has_trexio_amplitudesMethod
has_trexio_amplitudes(trexio::TrexioFile; unrestricted::Bool=false)

Check if amplitudes are stored in the TREXIO file using TREXIO has_* functions.

Returns true if any amplitude data (singles or doubles) is found. This function does not read the amplitudes, only checks for their presence.

source
ElemCo.TrexioInterface.has_trexio_determinantsMethod
has_trexio_determinants(trexio::TrexioFile) -> Bool

Check if determinants are stored in the TREXIO file (extended format with separate alpha/beta).

Returns true if determinant data with extended alpha/beta format is found.

source
ElemCo.TrexioInterface.occupied_virtual_from_classesMethod
occupied_virtual_from_classes(classes::Vector{String})

Extract occupied and virtual orbital indices from orbital class labels.

Returns (occ_indices, virt_indices) where:

  • occ_indices are orbitals with class "Inactive" or "Active"
  • virt_indices are orbitals with class "Virtual"

Note: "Core" and "Deleted" orbitals are not included in either list.

source
ElemCo.TrexioInterface.occupied_virtual_from_occupationsFunction
occupied_virtual_from_occupations(occupations::Vector{Float64}, classes::Vector{String}=String[]; 
                                  occ_threshold::Float64=0.5)

Extract occupied and virtual orbital indices from occupation numbers and optionally class labels.

Orbitals with occupation ≥ occ_threshold are considered occupied. If classes are provided, "Core" and "Deleted" orbitals are excluded from both lists.

Returns (occ_indices, virt_indices).

This is more reliable than occupied_virtual_from_classes for UHF orbitals where the same orbital index may be occupied for one spin but virtual for the other.

source
ElemCo.TrexioInterface.open_trexioFunction
open_trexio(filename::String, mode::String="r") -> TrexioFile

Open a TREXIO file. Returns an opened TrexioFile object. Compatible wrapper around the standard TREXIO API.

Arguments

  • filename::String: Path to the TREXIO file
  • mode::String: Access mode ("r" for read, "w" for write, "u" for read-write)
source
ElemCo.TrexioInterface.orbital_indices_from_classesMethod
orbital_indices_from_classes(classes::Vector{String}; include::Vector{String}=["Inactive", "Active", "Virtual"])

Extract orbital indices for each orbital class type from orbital class labels.

Arguments

  • classes: Vector of orbital class labels ("Core", "Inactive", "Active", "Virtual", "Deleted")
  • include: Which classes to include in the result (default: ["Inactive", "Active", "Virtual"])

Returns

A Dict{String,Vector{Int}} mapping each class name to the orbital indices with that class.

Example

classes = ["Core", "Inactive", "Inactive", "Virtual", "Virtual", "Virtual", "Deleted"]
result = orbital_indices_from_classes(classes)
# result["Inactive"] = [2, 3]
# result["Active"] = Int[]
# result["Virtual"] = [4, 5, 6]
source
ElemCo.TrexioInterface.read_trexio_basisMethod
read_trexio_basis(trexio::TrexioFile) -> BasisSet

Read basis set information from TREXIO file.

Returns empty BasisSet() if no molecular system or basis is stored (e.g., FCIDUMP-only case).

source
ElemCo.TrexioInterface.read_trexio_determinantsMethod
read_trexio_determinants(trexio::TrexioFile; OPattern::Type=UInt64) 
  -> (Vector{SimpleDeterminant{OPattern}}, Vector{Float64})

Read determinants and CI coefficients from TREXIO file.

Arguments

  • trexio::TrexioFile: Open TREXIO file handle
  • OPattern::Type: Orbital pattern type (default: UInt64, use UInt128 for >64 orbitals)

Returns

  • determinants::Vector{SimpleDeterminant{OPattern}}: Vector of determinants
  • coefficients::Vector{Float64}: CI coefficients

Example

using ElemCo
open_trexio("input.h5", "r") do trexio
    dets, coeffs = read_trexio_determinants(trexio)
    # For systems with >64 orbitals:
    # dets, coeffs = read_trexio_determinants(trexio; OPattern=UInt128)
end
source
ElemCo.TrexioInterface.read_trexio_orbital_classesFunction
read_trexio_orbital_classes(trexio::TrexioFile, MO="mo") -> (classa::Vector{String}, classb::Vector{String})

Read molecular orbital classes from TREXIO file and return as two vectors (alpha, beta).

For restricted orbitals the list of beta orbitals is empty. If no orbital classes are found, empty vectors are returned.

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.read_trexio_orbital_energiesFunction
read_trexio_orbital_energies(trexio::TrexioFile, MO="mo") -> (epsa, epsb)

Read molecular orbital energies from TREXIO file and return as two vectors (alpha, beta).

For restricted orbitals the list of beta orbitals is empty. If no orbital energies are found, empty vectors are returned.

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.read_trexio_orbital_occupationsFunction
read_trexio_orbital_occupations(trexio::TrexioFile, MO="mo") -> (occa, occb)

Read molecular orbital occupations from TREXIO file and return as two vectors (alpha, beta).

For restricted orbitals the list of beta orbitals is empty. If no orbital occupations are found, empty vectors are returned.

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.read_trexio_orbitalsFunction
read_trexio_orbitals(trexio::TrexioFile, basis=nothing; verbose=true, MO="mo") -> (SpinMatrix, String)

Read molecular orbitals from TREXIO file and return SpinMatrix and type::String.

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.read_trexio_rotationsMethod
read_trexio_rotations(trexio::TrexioFile; verbose=true, MO="mo") -> (SpinMatrix, String)

Read molecular orbital rotations from TREXIO file and return SpinMatrix and type::String.

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.write_trexio_amplitudesMethod
write_trexio_amplitudes(trexio::TrexioFile, T1::AbstractArray{Float64,2}, T2::AbstractArray{Float64,4})

Write CC amplitudes to TREXIO format using the standalone TREXIO module. This is a custom extension for storing amplitude data.

source
ElemCo.TrexioInterface.write_trexio_determinantsMethod
write_trexio_determinants(trexio::TrexioFile, determinants::Vector{<:AbstractDeterminant}, 
                          coefficients::AbstractVector{Float64})

Write determinants and CI coefficients to TREXIO file using extended format with separate alpha/beta bit fields.

Arguments

  • trexio::TrexioFile: Open TREXIO file handle (must be opened with write/update mode)
  • determinants::Vector{<:AbstractDeterminant}: Vector of determinants (must have alpha and beta fields)
  • coefficients::AbstractVector{Float64}: CI coefficients for each determinant

Storage Format

  • determinant.num: Number of determinants
  • determinant.n_int: Number of 64-bit integers per spin pattern (ceil(mo.num/64))
  • determinant.alpha: Alpha spin patterns as Int64 bit fields [nint, ndets]
  • determinant.beta: Beta spin patterns as Int64 bit fields [nint, ndets]
  • determinant.coefficient: CI coefficients [n_dets]

The number of orbitals is determined from mo.num in the TREXIO file. Bit i in the pattern indicates orbital i+1 is occupied (0-indexed bits).

Example

using ElemCo
open_trexio("output.h5", "w") do trexio
    # ... write orbitals first to set mo.num ...
    write_trexio_determinants(trexio, variational_dets, ci_coefficients)
end
source
ElemCo.TrexioInterface.write_trexio_orbitalsMethod
write_trexio_orbitals(trexio::TrexioFile, orbitals::SpinMatrix, basis::BasisSet;
                      type="HF", classes=(String[], String[]),
                      energies=(Float64[], Float64[]), occupations=(Float64[], Float64[]))

Write molecular orbitals to TREXIO file.

classes, energies, and occupations are optional and can be provided as tuples for alpha and beta spins. classes entries can be "Core", "Inactive", "Active", "Virtual", "Deleted"

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.write_trexio_rotationsMethod
write_trexio_rotations(trexio::TrexioFile, rotations::SpinMatrix;
                      type="Rotation", classes=(String[], String[]),
                      energies=(Float64[], Float64[]), occupations=(Float64[], Float64[]), MO="mo")

Write rotations of molecular orbitals to TREXIO file.

The rotations are written in place of orbitals, i.e., it is not possible to write rotations to a TREXIO file, which contains orbitals. classes, energies, and occupations are optional and can be provided as tuples for alpha and beta spins. classes entries can be "Core", "Inactive", "Active", "Virtual", "Deleted"

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.SimpleDeterminantType
SimpleDeterminant{OPattern}

Simple determinant type for TREXIO I/O. Holds alpha and beta occupation patterns. This is returned by read_trexio_determinants when reading from files. Can be converted to/from FCI.Determinant when FCI module is available.

source

Internal Functions

ElemCo.TrexioInterface._pack_pattern!Method
_pack_pattern!(dest::AbstractVector{Int64}, pattern::OPattern, n_int::Int) where OPattern

Pack an orbital pattern into an array of Int64 values. Orbital i (1-indexed) is stored in bit (i-1) % 64 of integer (i-1) ÷ 64 + 1.

source
ElemCo.TrexioInterface._read_trexio_orbital_transformationsFunction
_read_trexio_orbital_transformations(trexio::TrexioFile, order, verbose, MO="mo") -> (SpinMatrix, String)

Internal function to read orbital transformation coefficients from TREXIO file

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface._write_trexio_orbital_transformation_dataFunction
_write_trexio_orbital_transformation_data(trexio::TrexioFile, coefficients::SpinMatrix, 
                                         order, type, classes, energies, occupations, MO="mo")

Internal function to write orbital transformation data to TREXIO file.

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source
ElemCo.TrexioInterface.alphabeta_orbital_indicesFunction
alphabeta_orbital_indices(trexio::TrexioFile, nmo, MO="mo") -> (alpha_indices::Vector{Int}, beta_indices::Vector{Int})

Return the indices of alpha and beta orbitals.

For restricted orbitals the list of beta orbitals is empty.

MO can be "mo" for molecular orbitals or "po" for positron orbitals.

source