graspkit-atomic 3.4.1__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.

Potentially problematic release.


This version of graspkit-atomic might be problematic. Click here for more details.

Files changed (49) hide show
  1. graspkit_atomic-3.4.1/.gitignore +191 -0
  2. graspkit_atomic-3.4.1/INSTALL.md +79 -0
  3. graspkit_atomic-3.4.1/LICENSE +675 -0
  4. graspkit_atomic-3.4.1/PKG-INFO +167 -0
  5. graspkit_atomic-3.4.1/README.md +120 -0
  6. graspkit_atomic-3.4.1/README_zh.md +109 -0
  7. graspkit_atomic-3.4.1/build_package.py +53 -0
  8. graspkit_atomic-3.4.1/docs/releasing.md +156 -0
  9. graspkit_atomic-3.4.1/pyproject.toml +117 -0
  10. graspkit_atomic-3.4.1/scripts/check_release.py +234 -0
  11. graspkit_atomic-3.4.1/src/graspkit/CSFs_processor/__init__.py +56 -0
  12. graspkit_atomic-3.4.1/src/graspkit/CSFs_processor/coupling.py +386 -0
  13. graspkit_atomic-3.4.1/src/graspkit/CSFs_processor/extraction.py +129 -0
  14. graspkit_atomic-3.4.1/src/graspkit/CSFs_processor/selection.py +298 -0
  15. graspkit_atomic-3.4.1/src/graspkit/CSFs_processor/validation.py +230 -0
  16. graspkit_atomic-3.4.1/src/graspkit/__init__.py +11 -0
  17. graspkit_atomic-3.4.1/src/graspkit/data_IO/__init__.py +43 -0
  18. graspkit_atomic-3.4.1/src/graspkit/data_IO/file_locator.py +135 -0
  19. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/__init__.py +31 -0
  20. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/base_loader.py +114 -0
  21. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/binary_file_loader.py +370 -0
  22. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/energy_file_loader.py +150 -0
  23. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/gj_factor_loader.py +185 -0
  24. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/hyperfine_structure_loader.py +217 -0
  25. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/lsj_comp_loader.py +259 -0
  26. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/mix_coef_loader.py +261 -0
  27. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/radial_analysis_loader.py +134 -0
  28. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/radial_wavefunction_loader.py +280 -0
  29. graspkit_atomic-3.4.1/src/graspkit/data_IO/loaders/transition_loader.py +811 -0
  30. graspkit_atomic-3.4.1/src/graspkit/data_IO/mix_coef_writer.py +90 -0
  31. graspkit_atomic-3.4.1/src/graspkit/data_IO/produced_data_writor.py +129 -0
  32. graspkit_atomic-3.4.1/src/graspkit/grasp_data_extractor/__init__.py +56 -0
  33. graspkit_atomic-3.4.1/src/graspkit/grasp_data_extractor/asfs_data_processor.py +705 -0
  34. graspkit_atomic-3.4.1/src/graspkit/grasp_data_extractor/radial_analysis.py +523 -0
  35. graspkit_atomic-3.4.1/src/graspkit/grasp_data_extractor/radial_wavefunction_processor.py +71 -0
  36. graspkit_atomic-3.4.1/src/graspkit/grasp_data_extractor/rmix_data_processor.py +422 -0
  37. graspkit_atomic-3.4.1/src/graspkit/grasp_data_extractor/transition_data_processor.py +407 -0
  38. graspkit_atomic-3.4.1/src/graspkit/py.typed +1 -0
  39. graspkit_atomic-3.4.1/src/graspkit/utils/__init__.py +30 -0
  40. graspkit_atomic-3.4.1/src/graspkit/utils/data_modules.py +105 -0
  41. graspkit_atomic-3.4.1/src/graspkit/utils/environment_config.py +271 -0
  42. graspkit_atomic-3.4.1/src/graspkit/utils/quadrupole_deformation.py +72 -0
  43. graspkit_atomic-3.4.1/src/graspkit/utils/tool_function.py +91 -0
  44. graspkit_atomic-3.4.1/src/graspkit/version.py +3 -0
  45. graspkit_atomic-3.4.1/src/graspkit_plot/__init__.py +55 -0
  46. graspkit_atomic-3.4.1/src/graspkit_plot/fig_settings.py +1286 -0
  47. graspkit_atomic-3.4.1/src/graspkit_plot/mid_coupling.py +300 -0
  48. graspkit_atomic-3.4.1/src/graspkit_plot/plot_functions.py +801 -0
  49. graspkit_atomic-3.4.1/src/graspkit_plot/radial_analysis.py +180 -0
@@ -0,0 +1,191 @@
1
+ # Python cache files
2
+ __pycache__/
3
+ *.py[cod]
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
+ *.ipynb
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ #Pipfile.lock
97
+
98
+ # poetry
99
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
103
+ #poetry.lock
104
+
105
+ # pdm
106
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
107
+ #pdm.lock
108
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
109
+ # in version control.
110
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
111
+ .pdm.toml
112
+ .pdm-python
113
+ .pdm-build/
114
+
115
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
116
+ __pypackages__/
117
+
118
+ # Celery stuff
119
+ celerybeat-schedule
120
+ celerybeat.pid
121
+
122
+ # SageMath parsed files
123
+ *.sage.py
124
+
125
+ # Environments
126
+ .env
127
+ .venv
128
+ uv.lock
129
+ env/
130
+ venv/
131
+ ENV/
132
+ env.bak/
133
+ venv.bak/
134
+ .pixi
135
+ pixi.lock
136
+
137
+ # Spyder project settings
138
+ .spyderproject
139
+ .spyproject
140
+
141
+ # Rope project settings
142
+ .ropeproject
143
+
144
+ # mkdocs documentation
145
+ /site
146
+
147
+ # mypy
148
+ .mypy_cache/
149
+ .dmypy.json
150
+ dmypy.json
151
+
152
+ # Pyre type checker
153
+ .pyre/
154
+
155
+ # pytype static type analyzer
156
+ .pytype/
157
+
158
+ # Cython debug symbols
159
+ cython_debug/
160
+
161
+ # PyCharm
162
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
163
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
164
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
165
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
166
+ #.idea/
167
+
168
+ # Ruff stuff
169
+ .ruff_cache/
170
+
171
+ # PyPI configuration file
172
+ .pypirc
173
+
174
+ # Cursor AI editor
175
+ .cursorignore
176
+ .cursorindexingignore
177
+
178
+ # claude code
179
+ .CLAUDE.md
180
+
181
+ # System files
182
+ .DS_Store
183
+
184
+ # IDE settings
185
+ .vscode/
186
+ .idea/
187
+
188
+
189
+ # pixi environments
190
+ .pixi/*
191
+ !.pixi/config.toml
@@ -0,0 +1,79 @@
1
+ # Installation
2
+
3
+ `graspkit-atomic` requires Python 3.14 or newer. It provides the `graspkit` and
4
+ `graspkit_plot` import packages. The distribution name is changing from `grasp-atomic-kit` to `graspkit-atomic`;
5
+ existing import statements need no changes. The commands below apply after the
6
+ first release under the new name. For existing projects, replace the old
7
+ dependency rather than declaring both distributions, which provide the same
8
+ Python packages.
9
+
10
+ ## Install from PyPI
11
+
12
+ ```bash
13
+ python -m pip install graspkit-atomic
14
+ ```
15
+
16
+ For a fixed release:
17
+
18
+ ```bash
19
+ python -m pip install "graspkit-atomic==3.4.1"
20
+ ```
21
+
22
+ ## Declare a project dependency
23
+
24
+ Add `"graspkit-atomic==3.4.1"` to the existing `[project].dependencies` list in
25
+ your own `pyproject.toml`. A minimal example:
26
+
27
+ ```toml
28
+ [project]
29
+ name = "atomic-analysis"
30
+ version = "0.1.0"
31
+ requires-python = ">=3.14"
32
+ dependencies = ["graspkit-atomic==3.4.1"]
33
+ ```
34
+
35
+ Install your consuming project and its dependencies from its directory with
36
+ `python -m pip install .`. Add `"rcsfs==1.3.1"` to the dependency list separately
37
+ if your application also needs the Rust CSF library.
38
+
39
+ Pip installs the declared runtime dependencies; Rust and the GRASP executables
40
+ are not needed to install this Python library. Reading calculation results
41
+ requires the corresponding GRASP data files.
42
+
43
+ ## Local wheel or source installation
44
+
45
+ To install a downloaded wheel, use its exact filename:
46
+
47
+ ```bash
48
+ python -m pip install /path/to/graspkit_atomic-3.4.1-py3-none-any.whl
49
+ ```
50
+
51
+ A standalone source checkout also supports `python -m pip install .`.
52
+
53
+ ## Full workspace development
54
+
55
+ Use the environment owned by Tools. Run setup from `graspkit-tools/` only:
56
+
57
+ ```bash
58
+ cd ../graspkit-tools
59
+ uv sync --extra cpu
60
+ source .venv/bin/activate
61
+ python -c "import graspkit; print(graspkit.__version__)"
62
+ ```
63
+
64
+ Select `--extra gpu` instead on a CUDA host. On Windows activate
65
+ `.venv\Scripts\activate` after syncing. Tools installs GraspKit as an editable
66
+ path dependency; ordinary Python edits are immediately visible. Do not install
67
+ release wheels into this shared environment for testing: the release checker
68
+ loads an unpacked wheel in a disposable directory instead.
69
+
70
+ ## Verification
71
+
72
+ ```bash
73
+ python -c "from graspkit.data_IO import EnergyFileLoader; print(EnergyFileLoader)"
74
+ python -c "import graspkit_plot; print(graspkit_plot.__file__)"
75
+ ```
76
+
77
+ For builds and artifact tests, see [the release guide](docs/releasing.md).
78
+ PyTorch, scikit-learn and training workflows belong to `graspkit-tools` and
79
+ are not dependencies of this library.