aegiss 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. aegiss-0.1.0/.git_archival.txt +3 -0
  2. aegiss-0.1.0/.gitattributes +1 -0
  3. aegiss-0.1.0/.gitignore +229 -0
  4. aegiss-0.1.0/.grant.yaml +49 -0
  5. aegiss-0.1.0/.mailmap +8 -0
  6. aegiss-0.1.0/.python-version +1 -0
  7. aegiss-0.1.0/CHANGELOG.md +39 -0
  8. aegiss-0.1.0/CITATION.cff +439 -0
  9. aegiss-0.1.0/CLA.md +138 -0
  10. aegiss-0.1.0/CODE_OF_CONDUCT.md +124 -0
  11. aegiss-0.1.0/CONTRIBUTING.md +146 -0
  12. aegiss-0.1.0/LICENSE +201 -0
  13. aegiss-0.1.0/NOTICE +6 -0
  14. aegiss-0.1.0/PKG-INFO +223 -0
  15. aegiss-0.1.0/README.md +179 -0
  16. aegiss-0.1.0/SECURITY.md +11 -0
  17. aegiss-0.1.0/docs/README.md +111 -0
  18. aegiss-0.1.0/docs/api/active_space.md +37 -0
  19. aegiss-0.1.0/docs/api/config.md +24 -0
  20. aegiss-0.1.0/docs/api/index.md +22 -0
  21. aegiss-0.1.0/docs/api/initial_guess.md +17 -0
  22. aegiss-0.1.0/docs/api/localization.md +57 -0
  23. aegiss-0.1.0/docs/api/utils.md +239 -0
  24. aegiss-0.1.0/docs/api/wavefunction.md +23 -0
  25. aegiss-0.1.0/docs/assets/images/after_tagging_lateral.png +0 -0
  26. aegiss-0.1.0/docs/assets/images/ao_suggestion_benzene.png +0 -0
  27. aegiss-0.1.0/docs/assets/images/ao_suggestion_options.png +0 -0
  28. aegiss-0.1.0/docs/assets/images/atom_info_selected_benzene.png +0 -0
  29. aegiss-0.1.0/docs/assets/images/auto_align.png +0 -0
  30. aegiss-0.1.0/docs/assets/images/example_ao_contribution_heatmap.png +0 -0
  31. aegiss-0.1.0/docs/assets/images/example_pie_composition_alpha.png +0 -0
  32. aegiss-0.1.0/docs/assets/images/example_soe_heatmap.png +0 -0
  33. aegiss-0.1.0/docs/assets/images/example_th_plot.png +0 -0
  34. aegiss-0.1.0/docs/assets/images/geometry_section.png +0 -0
  35. aegiss-0.1.0/docs/assets/images/main_screen.png +0 -0
  36. aegiss-0.1.0/docs/assets/images/main_screen_selected.png +0 -0
  37. aegiss-0.1.0/docs/assets/images/spatial_orientation.png +0 -0
  38. aegiss-0.1.0/docs/citing.md +222 -0
  39. aegiss-0.1.0/docs/contributing.md +148 -0
  40. aegiss-0.1.0/docs/developer.md +54 -0
  41. aegiss-0.1.0/docs/documenting.md +32 -0
  42. aegiss-0.1.0/docs/index.md +133 -0
  43. aegiss-0.1.0/docs/installation.md +94 -0
  44. aegiss-0.1.0/docs/javascripts/mathjax.js +12 -0
  45. aegiss-0.1.0/docs/moltagger.md +200 -0
  46. aegiss-0.1.0/docs/orbital_indexing.md +128 -0
  47. aegiss-0.1.0/docs/testing.md +20 -0
  48. aegiss-0.1.0/docs/tutorials/01_scf_and_localization.ipynb +215 -0
  49. aegiss-0.1.0/docs/tutorials/02_dmrg.ipynb +345 -0
  50. aegiss-0.1.0/docs/tutorials/03_ao_projection.ipynb +617 -0
  51. aegiss-0.1.0/docs/tutorials/04_aegiss.ipynb +681 -0
  52. aegiss-0.1.0/docs/tutorials/05_unrestricted.ipynb +327 -0
  53. aegiss-0.1.0/docs/tutorials/data/benzene.xyz +14 -0
  54. aegiss-0.1.0/docs/tutorials/data/benzene_wanky.xyz +14 -0
  55. aegiss-0.1.0/docs/tutorials/data/dabna_orca_MS.xyz +56 -0
  56. aegiss-0.1.0/docs/tutorials/data/dobna.xyz +34 -0
  57. aegiss-0.1.0/docs/tutorials/data/feo4_avas.xyz +8 -0
  58. aegiss-0.1.0/docs/tutorials/data/ferrocene_avas.xyz +23 -0
  59. aegiss-0.1.0/docs/tutorials/data/trans_cl.xyz +29 -0
  60. aegiss-0.1.0/docs/tutorials/data/water.xyz +5 -0
  61. aegiss-0.1.0/docs/tutorials/index.md +268 -0
  62. aegiss-0.1.0/docs/uhf.md +342 -0
  63. aegiss-0.1.0/examples/README.md +11 -0
  64. aegiss-0.1.0/examples/minimal_example.py +54 -0
  65. aegiss-0.1.0/main.py +105 -0
  66. aegiss-0.1.0/mkdocs.yml +129 -0
  67. aegiss-0.1.0/mol_tagger.py +38 -0
  68. aegiss-0.1.0/pyproject.toml +241 -0
  69. aegiss-0.1.0/src/aegiss/__init__.py +37 -0
  70. aegiss-0.1.0/src/aegiss/_version.py +24 -0
  71. aegiss-0.1.0/src/aegiss/active_space/__init__.py +21 -0
  72. aegiss-0.1.0/src/aegiss/active_space/aegiss.py +446 -0
  73. aegiss-0.1.0/src/aegiss/active_space/ao_projection.py +622 -0
  74. aegiss-0.1.0/src/aegiss/active_space/entropy_screening.py +279 -0
  75. aegiss-0.1.0/src/aegiss/cli.py +154 -0
  76. aegiss-0.1.0/src/aegiss/config_dataclasses/__init__.py +22 -0
  77. aegiss-0.1.0/src/aegiss/config_dataclasses/dmrg_config.py +159 -0
  78. aegiss-0.1.0/src/aegiss/config_dataclasses/entropy_config.py +69 -0
  79. aegiss-0.1.0/src/aegiss/config_dataclasses/output_config.py +58 -0
  80. aegiss-0.1.0/src/aegiss/config_dataclasses/projection_config.py +170 -0
  81. aegiss-0.1.0/src/aegiss/initial_guess/__init__.py +19 -0
  82. aegiss-0.1.0/src/aegiss/initial_guess/scf.py +173 -0
  83. aegiss-0.1.0/src/aegiss/localization/__init__.py +35 -0
  84. aegiss-0.1.0/src/aegiss/localization/fnos.py +66 -0
  85. aegiss-0.1.0/src/aegiss/localization/nos.py +77 -0
  86. aegiss-0.1.0/src/aegiss/localization/orbital_localization.py +380 -0
  87. aegiss-0.1.0/src/aegiss/py.typed +0 -0
  88. aegiss-0.1.0/src/aegiss/utils/__init__.py +59 -0
  89. aegiss-0.1.0/src/aegiss/utils/banner.py +48 -0
  90. aegiss-0.1.0/src/aegiss/utils/dmrg_utils.py +274 -0
  91. aegiss-0.1.0/src/aegiss/utils/dump.py +119 -0
  92. aegiss-0.1.0/src/aegiss/utils/env.py +110 -0
  93. aegiss-0.1.0/src/aegiss/utils/logging.py +91 -0
  94. aegiss-0.1.0/src/aegiss/utils/mo_composition.py +353 -0
  95. aegiss-0.1.0/src/aegiss/utils/mol_tagger/README.md +34 -0
  96. aegiss-0.1.0/src/aegiss/utils/mol_tagger/__init__.py +93 -0
  97. aegiss-0.1.0/src/aegiss/utils/mol_tagger/_ao_suggest.py +439 -0
  98. aegiss-0.1.0/src/aegiss/utils/mol_tagger/_atoms.py +248 -0
  99. aegiss-0.1.0/src/aegiss/utils/mol_tagger/_constants.py +136 -0
  100. aegiss-0.1.0/src/aegiss/utils/mol_tagger/_renderer.py +172 -0
  101. aegiss-0.1.0/src/aegiss/utils/mol_tagger/_window.py +647 -0
  102. aegiss-0.1.0/src/aegiss/utils/orb_display.py +210 -0
  103. aegiss-0.1.0/src/aegiss/utils/orbital_indices.py +244 -0
  104. aegiss-0.1.0/src/aegiss/utils/plotting.py +981 -0
  105. aegiss-0.1.0/src/aegiss/wavefunction/__init__.py +20 -0
  106. aegiss-0.1.0/src/aegiss/wavefunction/dmrg_subprocess.py +289 -0
  107. aegiss-0.1.0/src/aegiss/wavefunction/methods.py +102 -0
  108. aegiss-0.1.0/tests/__init__.py +13 -0
  109. aegiss-0.1.0/tests/conftest.py +141 -0
  110. aegiss-0.1.0/tests/test_aegiss.py +671 -0
  111. aegiss-0.1.0/tests/test_ao_projection.py +744 -0
  112. aegiss-0.1.0/tests/test_config_dataclasses.py +356 -0
  113. aegiss-0.1.0/tests/test_dmrg_integration.py +112 -0
  114. aegiss-0.1.0/tests/test_dmrg_subprocess.py +410 -0
  115. aegiss-0.1.0/tests/test_dmrg_utils.py +370 -0
  116. aegiss-0.1.0/tests/test_dump.py +49 -0
  117. aegiss-0.1.0/tests/test_entropy_screening.py +253 -0
  118. aegiss-0.1.0/tests/test_env.py +147 -0
  119. aegiss-0.1.0/tests/test_localization.py +236 -0
  120. aegiss-0.1.0/tests/test_logging.py +103 -0
  121. aegiss-0.1.0/tests/test_methods.py +108 -0
  122. aegiss-0.1.0/tests/test_mo_composition.py +237 -0
  123. aegiss-0.1.0/tests/test_mol_tagger.py +517 -0
  124. aegiss-0.1.0/tests/test_orb_display.py +303 -0
  125. aegiss-0.1.0/tests/test_orbital_indices.py +278 -0
  126. aegiss-0.1.0/tests/test_plotting.py +534 -0
  127. aegiss-0.1.0/tests/test_scf.py +237 -0
  128. aegiss-0.1.0/uv.lock +3077 -0
@@ -0,0 +1,3 @@
1
+ node: $Format:%H$
2
+ node-date: $Format:%cI$
3
+ describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
@@ -0,0 +1 @@
1
+ .git_archival.txt export-subst
@@ -0,0 +1,229 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ #uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ #poetry.lock
109
+ #poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ #pdm.lock
116
+ #pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ #pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # SageMath parsed files
135
+ *.sage.py
136
+
137
+ # Environments
138
+ .env
139
+ .venv
140
+ env/
141
+ venv/
142
+ ENV/
143
+ env.bak/
144
+ venv.bak/
145
+
146
+ # Spyder project settings
147
+ .spyderproject
148
+ .spyproject
149
+
150
+ # Rope project settings
151
+ .ropeproject
152
+
153
+ # mkdocs documentation
154
+ /site
155
+
156
+ # mypy
157
+ .mypy_cache/
158
+ .dmypy.json
159
+ dmypy.json
160
+
161
+ # Pyre type checker
162
+ .pyre/
163
+
164
+ # pytype static type analyzer
165
+ .pytype/
166
+
167
+ # Cython debug symbols
168
+ cython_debug/
169
+
170
+ # PyCharm
171
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
172
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
173
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
174
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
175
+ #.idea/
176
+
177
+ # Abstra
178
+ # Abstra is an AI-powered process automation framework.
179
+ # Ignore directories containing user credentials, local state, and settings.
180
+ # Learn more at https://abstra.io/docs
181
+ .abstra/
182
+
183
+ # Visual Studio Code
184
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
185
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
186
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
187
+ # you could uncomment the following to ignore the entire vscode folder
188
+ .vscode/
189
+
190
+ # Ruff stuff:
191
+ .ruff_cache/
192
+
193
+ # PyPI configuration file
194
+ .pypirc
195
+
196
+ # Cursor
197
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
198
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
199
+ # refer to https://docs.cursor.com/context/ignore-files
200
+ .cursorignore
201
+ .cursorindexingignore
202
+
203
+ # Marimo
204
+ marimo/_static/
205
+ marimo/_lsp/
206
+ __marimo__/
207
+
208
+ # macOS
209
+ .DS_Store
210
+
211
+ # AEGISS runtime scratch/output (SCRATCH_DIR default, OutputConfig default)
212
+ /tmp/
213
+ aegiss_output/
214
+
215
+ # Local developer scratch scripts and their DMRG scratch dir — never pushed.
216
+ # Also excluded from ruff via [tool.ruff] exclude in pyproject.toml.
217
+ /scripts/
218
+
219
+ # Written by `just sbom`
220
+ /sbom/
221
+
222
+ # Local, never-pushed working files (generated cubes/plots, FCIDUMPs, test runs).
223
+ /local/
224
+
225
+ # Written by hatch-vcs at build time
226
+ src/aegiss/_version.py
227
+
228
+ # nix-direnv state (.envrc itself is tracked: it loads the Nix dev shell)
229
+ .direnv/
@@ -0,0 +1,49 @@
1
+ # License policy for the runtime dependencies, checked by `just sbom-check` with anchore/grant
2
+ # (https://oss.anchore.com/docs/guides/license/policies/) against the SBOMs from `just sbom`.
3
+ #
4
+ # AEGISS is released under Apache-2.0: allow what an Apache-2.0 library may depend on. Matching is
5
+ # case-sensitive and `*` is a glob. A package must match on every license it declares.
6
+
7
+ allow:
8
+ # Permissive
9
+ - 0BSD
10
+ - Apache-2.0
11
+ - BSD-*-Clause
12
+ - CC0-1.0
13
+ - ISC
14
+ - MIT
15
+ - MIT-CMU
16
+ - PSF-2.0
17
+ - Python-2.0
18
+ - Unlicense
19
+ - Zlib
20
+ # Weak copyleft: fine for unmodified dependencies installed alongside AEGISS, not for code
21
+ # copied into it.
22
+ - LGPL-2.1-only
23
+ - LGPL-2.1-or-later
24
+ - LGPL-3.0-only
25
+ - LGPL-3.0-or-later
26
+ - MPL-2.0
27
+ # Trove classifiers, for packages that declare no SPDX identifier
28
+ - "License :: OSI Approved :: Apache Software License"
29
+ - "License :: OSI Approved :: BSD License"
30
+ - "License :: OSI Approved :: MIT License"
31
+ - "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)"
32
+
33
+ # Reviewed by hand. Every entry needs the reason it passes; drop it when the reason goes.
34
+ ignore-packages:
35
+ # GPL-3.0-only. AEGISS runs `block2main` as a separate program and exchanges only files
36
+ # (FCIDUMP and input in, density matrices out); it never imports or links block2, so the
37
+ # GPL does not reach AEGISS (https://www.gnu.org/licenses/gpl-faq.html#MereAggregation).
38
+ # See the note at the top of src/aegiss/wavefunction/dmrg_subprocess.py. Anything that
39
+ # ships block2 itself (a container image, a frozen bundle) must meet the GPL for block2.
40
+ - block2
41
+ # `LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only`: we take the LGPL-3.0 option. grant
42
+ # checks each alternative of an OR expression, so it denies the GPL ones.
43
+ - PySide6_Essentials
44
+ - shiboken6
45
+ # Public domain and BSD-2-Clause. Its GPL classifier covers tools/editors/emacs/rst.el
46
+ # alone, which the wheel does not ship (https://docutils.sourceforge.io/COPYING.html).
47
+ - docutils
48
+
49
+ require-license: true
aegiss-0.1.0/.mailmap ADDED
@@ -0,0 +1,8 @@
1
+ # Entries in this file are made for two reasons:
2
+ # 1) to merge multiple git commit authors that correspond to a single author
3
+ # 2) to change the canonical name and/or email address of an author.
4
+ #
5
+ # See `git help mailmap` for the format.
6
+
7
+ Fabio Tarocco <fabio.tarocco@algorithmiq.fi> FabioTarocco <fabio.tarocco.vr@gmail.com>
8
+ Fabio Tarocco <fabio.tarocco@algorithmiq.fi> FabioTarocco <54395661+FabioTarocco@users.noreply.github.com>
@@ -0,0 +1 @@
1
+ 3.12
@@ -0,0 +1,39 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are listed here.
4
+
5
+ ## 0.1.0 (2026-10-28)
6
+
7
+ ### Features
8
+
9
+ - Additional localization procedure (#46)
10
+ - Added format (#54)
11
+ - Added resolution space without SOE (#55)
12
+ - Added beta components to `plot_ao_contributions` (#58)
13
+ - Add `mo_composition` (#59)
14
+ - Add `clusters` grouping to mo_ao_contributions (#61)
15
+ - Simple `chemcore` core identification; (#57)
16
+ - Started UHF integration (#62)
17
+ - Orbital index mutable setup (#65)
18
+
19
+ ### Fixes
20
+
21
+ - Improved plateau visibility
22
+ - Expose AO contributions and update outdated tutorials (#71)
23
+ - Use mulliken as default pop_method for Pipek-Mezey (#72)
24
+ - IAO shape, Pipek-Mezey occupied pop_method and plot output names (#76)
25
+ - **scf:** Log the mean-field energy after the SCF (#86)
26
+
27
+ ### Documentation
28
+
29
+ - Refining `mkdocs` (#64)
30
+ - **localization:** Explain why the DMRG window is not a frontier window for localized orbitals (#75)
31
+ - Fix docstrings that no longer match the code (#79)
32
+ - **plotting:** Explain how to use the MI plots with an external mutual-information matrix (#81)
33
+ - Trim the README to an entry point and fix stale docs pages (#77)
34
+ - **tutorials:** Use a CAS(18,18) window in 03/04 and fix stale tutorial text (#78)
35
+ - Deploy the site, run the doc code blocks and add a developer guide (#88)
36
+ - **uhf:** Validate the entropies against PySCF FCI instead of pyblock2 (#93)
37
+ - **site:** Show the Apache licence on the docs site (#101)
38
+ - **citing:** Cite AEGISS and the work it builds on (#102)
39
+ - **contributing:** Document the Apache-2.0 licence header (#104)