Skip to content

Commit 57cad8b

Browse files
authored
Localized system docs (#178)
1 parent 2061f52 commit 57cad8b

File tree

3 files changed

+125
-14
lines changed

3 files changed

+125
-14
lines changed

docs/jupyter_execute/notebooks/localization.ipynb

Lines changed: 105 additions & 6 deletions
Large diffs are not rendered by default.

docs/source/localizers.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,14 @@ After projection is performed, virtual orbitals can be localized using the embed
2424
:undoc-members:
2525
:show-inheritance:
2626
```
27+
28+
## Localisation Data
29+
30+
Outputs from `OccupiedLocalizer.localize` are standardised as a dataclass, `LocalizedSystem`
31+
32+
```{eval-rst}
33+
.. automodule:: nbed.localizers.system
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
```

nbed/localizers/system.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@
99
class LocalizedSystem:
1010
"""Required data from localized system.
1111
12-
active_mo_inds (np.array): 1D array of active occupied MO indices
13-
enviro_mo_inds (np.array): 1D array of environment occupied MO indices
14-
c_active (np.array): C matrix of localized occupied active MOs (columns define MOs)
15-
c_enviro (np.array): C matrix of localized occupied ennironment MOs
16-
c_loc_occ (np.array): C matrix of localized occupied MOs
17-
c_loc_virt (np.array | None): C matrix of localized virual MOs.
18-
dm_active (np.array): active system density matrix
19-
dm_enviro (np.array): environment system density matrix
12+
Args:
13+
active_mo_inds (np.array): 1D array of active occupied MO indices.
14+
enviro_mo_inds (np.array): 1D array of environment occupied MO indices.
15+
c_active (np.array): C matrix of localized occupied active MOs (columns define MOs).
16+
c_enviro (np.array): C matrix of localized occupied ennironment MOs.
17+
c_loc_occ (np.array): C matrix of localized occupied MOs.
18+
c_loc_virt (np.array | None): C matrix of localized virual MOs.
19+
dm_active (np.array): active system density matrix.
20+
dm_enviro (np.array): environment system density matrix.
2021
"""
2122

2223
active_mo_inds: NDArray

0 commit comments

Comments
 (0)