TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-11-03 20:54:07 +01:00
Code Issues Projects Releases Wiki Activity

Improved documentation

Browse Source
This commit is contained in:
Anthony Scemama 2022-12-26 13:27:45 +01:00
parent bab56408e1
commit 1451a94eaa
1 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
trex.org
View File

@ -766,18 +766,18 @@ prim_factor =
\Psi = \sum_I C_I \psi_I. \Psi = \sum_I C_I \psi_I.
\] \]
Each CSF is a linear combination of Slater determinants. Slater Each CSF $\psi_I$ is a linear combination of Slater determinants. Slater
determinants are stored in the =determinant= section. In this group determinants are stored in the =determinant= section. In this group
we store the CI coefficients in the basis of CSFs, and the we store the CI coefficients in the basis of CSFs, and the
matrix $\langle D_I | \psi_J \rangle$ needed to project the CSFs in matrix $\langle D_I | \psi_J \rangle$ needed to project the CSFs in
the basis of Slater determinants. the basis of Slater determinants.
#+NAME: csf #+NAME: csf
| Variable | Type | Dimensions | Description | | Variable | Type | Dimensions | Description |
|-------------------+------------------+-----------------------------+------------------------------------------------| |-------------------+------------------+-----------------------------+-----------------------------------------|
| ~num~ | ~dim readonly~ | | Number of CSFs | | ~num~ | ~dim readonly~ | | Number of CSFs |
| ~coefficient~ | ~float buffered~ | ~(csf.num)~ | Coefficients of the CSFs from the CI expansion | | ~coefficient~ | ~float buffered~ | ~(csf.num)~ | Coefficients $C_I$ of the CSF expansion |
| ~det_coefficient~ | ~float sparse~ | ~(determinant.num,csf.num)~ | Projection on the determinant basis | | ~det_coefficient~ | ~float sparse~ | ~(determinant.num,csf.num)~ | Projection on the determinant basis |
#+CALL: json(data=csf, title="csf") #+CALL: json(data=csf, title="csf")
@ -794,23 +794,25 @@ prim_factor =
* Excited states (state group) * Excited states (state group)
This group contains information about excited state. Since TREXIO version 2.3.0 This group contains information about excited states. Since only a
the state-specific data (e.g. CI/CSF coeffcients, RDMs) is written in a separate single state can be stored in a TREXIO file, it is possible to store
file in order to avoid over-complicated internal logics and global state switches. in the main TREXIO file the names of auxiliary files containing the
information of the other states.
The ~file_name~ and ~label~ arrays have to be written only for the master file, The ~file_name~ and ~label~ arrays have to be written only for the
e.g. the one containing the ground state wave function. main file, e.g. the one containing the ground state wave function
The ~id~ and ~current_label~ attributes have to be specified for each file together with the basis set parameters, molecular orbitals,
(containing both ground and excited state data). integrals, etc.
The ~id~ and ~current_label~ attributes need to be specified for each file.
#+NAME: state #+NAME: state
| Variable | Type | Dimensions | Description | | Variable | Type | Dimensions | Description |
|-----------------+-------+---------------+-----------------------------------------------------------------------------------------------| |-----------------+-------+---------------+---------------------------------------------------------------------------------------------|
| ~num~ | ~dim~ | | Number of states (including the ground state) | | ~num~ | ~dim~ | | Number of states (including the ground state) |
| ~id~ | ~int~ | | Index of a current state (0 is ground state) | | ~id~ | ~int~ | | Index of the current state (0 is ground state) |
| ~label~ | ~str~ | ~(state.num)~ | Labels of all states related to this file (e.g. 'S' for singlets) | | ~current_label~ | ~str~ | | Label of the current state |
| ~current_label~ | ~str~ | | Labels of the current state that is in a file | | ~label~ | ~str~ | ~(state.num)~ | Labels of all states |
| ~file_name~ | ~str~ | ~(state.num)~ | Names of the TREXIO files linked to the current one (i.e. containing data for excited states) | | ~file_name~ | ~str~ | ~(state.num)~ | Names of the TREXIO files linked to the current one (i.e. containing data for other states) |
#+CALL: json(data=state, title="state") #+CALL: json(data=state, title="state")
@ -818,11 +820,11 @@ prim_factor =
:results: :results:
#+begin_src python :tangle trex.json #+begin_src python :tangle trex.json
"state": { "state": {
"num" : [ "dim", [] ] "num" : [ "dim", [] ]
, "id" : [ "int", [] ] , "id" : [ "int", [] ]
, "label" : [ "str", [ "state.num" ] ] , "current_label" : [ "str", [] ]
, "current_label" : [ "str", [] ] , "label" : [ "str", [ "state.num" ] ]
, "file_name" : [ "str", [ "state.num" ] ] , "file_name" : [ "str", [ "state.num" ] ]
} , } ,
#+end_src #+end_src
:end: :end: