atomic_femdvr 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.
- atomic_femdvr-0.1.0/LICENSE +21 -0
- atomic_femdvr-0.1.0/PKG-INFO +181 -0
- atomic_femdvr-0.1.0/README.md +139 -0
- atomic_femdvr-0.1.0/pyproject.toml +230 -0
- atomic_femdvr-0.1.0/pyproject.toml.orig +266 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/__init__.py +1 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/__main__.py +12 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/adaptive_elements.py +164 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/atom_dft.py +108 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/bessel_transform.py +58 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/cli.py +96 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/confinement.py +63 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/density_potential.py +153 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/dipoles.py +100 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/femdvr.py +592 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/full_atom_dft.py +177 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/full_atomic.py +118 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/initial_density.py +109 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/input.py +162 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/interp_tools.py +43 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/kohn_sham.py +328 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/legendre.py +158 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/legendre_integrals.py +58 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/mixing.py +66 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/periodic_table.py +31 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/photo_atomic.py +100 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/photo_pseudo.py +112 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/photoemission.py +300 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/projector_output.py +184 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/pseudo_atom_dft.py +363 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/pseudo_atomic.py +179 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/py.typed +1 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/scattering.py +327 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/upf.py +175 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/utils.py +98 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/version.py +39 -0
- atomic_femdvr-0.1.0/src/atomic_femdvr/xc_functionals.py +247 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Michael Schüler
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: atomic_femdvr
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Kohn-Sham solver for isolated atoms (all-electron and norm-conserving pseudopotentials) using the finite-element discrete variable representation
|
|
5
|
+
Keywords: density functional theory,Kohn-Sham,atom,pseudopotential,UPF,finite element,discrete variable representation,atomic orbitals,snekpack
|
|
6
|
+
Author: Michael Schüler
|
|
7
|
+
Author-email: Michael Schüler <michael.schueler@psi.ch>
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Classifier: Development Status :: 3 - Alpha
|
|
10
|
+
Classifier: Environment :: Console
|
|
11
|
+
Classifier: Intended Audience :: Science/Research
|
|
12
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Natural Language :: English
|
|
15
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
16
|
+
Classifier: Topic :: Scientific/Engineering :: Chemistry
|
|
17
|
+
Classifier: Programming Language :: Python
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
23
|
+
Classifier: Typing :: Typed
|
|
24
|
+
Requires-Dist: click
|
|
25
|
+
Requires-Dist: typing-extensions
|
|
26
|
+
Requires-Dist: numpy
|
|
27
|
+
Requires-Dist: scipy
|
|
28
|
+
Requires-Dist: pydantic>=2
|
|
29
|
+
Requires-Dist: upf-tools
|
|
30
|
+
Requires-Dist: h5py
|
|
31
|
+
Requires-Dist: sympy
|
|
32
|
+
Requires-Dist: matplotlib ; extra == 'plot'
|
|
33
|
+
Maintainer: Michael Schüler
|
|
34
|
+
Maintainer-email: Michael Schüler <michael.schueler@psi.ch>
|
|
35
|
+
Requires-Python: >=3.10
|
|
36
|
+
Project-URL: Bug Tracker, https://github.com/michaelschueler/atomic-femdvr/issues
|
|
37
|
+
Project-URL: Homepage, https://github.com/michaelschueler/atomic-femdvr
|
|
38
|
+
Project-URL: Repository, https://github.com/michaelschueler/atomic-femdvr.git
|
|
39
|
+
Project-URL: Documentation, https://atomic-femdvr.readthedocs.io
|
|
40
|
+
Provides-Extra: plot
|
|
41
|
+
Description-Content-Type: text/markdown
|
|
42
|
+
|
|
43
|
+
<h1 align="center">
|
|
44
|
+
atomic-femdvr
|
|
45
|
+
</h1>
|
|
46
|
+
|
|
47
|
+
<p align="center">
|
|
48
|
+
<a href="https://github.com/michaelschueler/atomic-femdvr/actions/workflows/tests.yml">
|
|
49
|
+
<img alt="Tests" src="https://github.com/michaelschueler/atomic-femdvr/actions/workflows/tests.yml/badge.svg" /></a>
|
|
50
|
+
<a href="https://pypi.org/project/atomic_femdvr">
|
|
51
|
+
<img alt="PyPI" src="https://img.shields.io/pypi/v/atomic_femdvr" /></a>
|
|
52
|
+
<a href="https://pypi.org/project/atomic_femdvr">
|
|
53
|
+
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/atomic_femdvr" /></a>
|
|
54
|
+
<a href="https://github.com/michaelschueler/atomic-femdvr/blob/main/LICENSE">
|
|
55
|
+
<img alt="License" src="https://img.shields.io/pypi/l/atomic_femdvr" /></a>
|
|
56
|
+
<a href="https://atomic-femdvr.readthedocs.io/en/latest/?badge=latest">
|
|
57
|
+
<img alt="Documentation Status" src="https://readthedocs.org/projects/atomic-femdvr/badge/?version=latest" /></a>
|
|
58
|
+
</p>
|
|
59
|
+
|
|
60
|
+
Kohn-Sham solver for isolated atoms using the finite-element discrete variable
|
|
61
|
+
representation (FE-DVR).
|
|
62
|
+
|
|
63
|
+
- **Pseudo-atoms** with norm-conserving pseudopotentials in UPF format, including
|
|
64
|
+
pseudopotentials without pseudo-atomic orbitals (e.g. SG15)
|
|
65
|
+
- **All-electron atoms** (non-relativistic), plus approximate scalar-relativistic
|
|
66
|
+
(Koelling-Harmon) and ZORA treatments
|
|
67
|
+
- LDA and GGA functionals: PBE built in, all others via
|
|
68
|
+
[libxc](https://libxc.gitlab.io)
|
|
69
|
+
- **Confined atomic orbitals** with polarization functions for use as localized
|
|
70
|
+
basis functions or projectors, exported on a logarithmic grid (Quantum ESPRESSO
|
|
71
|
+
style), on the FE-DVR grid, or as spherical Bessel transforms; dipole matrix
|
|
72
|
+
elements
|
|
73
|
+
- **Photoemission**: scattering phase shifts and dipole matrix elements to
|
|
74
|
+
continuum states
|
|
75
|
+
|
|
76
|
+
## 🚀 Installation
|
|
77
|
+
|
|
78
|
+
```console
|
|
79
|
+
$ python3 -m pip install atomic_femdvr
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
The built-in exchange-correlation driver provides PBE. Other functionals (e.g. the
|
|
83
|
+
LDA used for the NIST benchmark) need the libxc Python bindings, which are not on
|
|
84
|
+
PyPI; see the
|
|
85
|
+
[installation guide](https://atomic-femdvr.readthedocs.io/en/latest/installation.html).
|
|
86
|
+
|
|
87
|
+
## 💪 Getting started
|
|
88
|
+
|
|
89
|
+
Calculations are defined by a JSON input file. A pseudo-atom with a confinement
|
|
90
|
+
potential and polarization orbitals (`examples/Si_Pseudo.json`):
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"control": { "storage_dir": "./Si_pseudo" },
|
|
95
|
+
"sysparams": {
|
|
96
|
+
"element": "Si",
|
|
97
|
+
"file_upf": "../tests/data/Si/Si.oncvpsp.upf",
|
|
98
|
+
"lmax": 2,
|
|
99
|
+
"nmax": 1
|
|
100
|
+
},
|
|
101
|
+
"dft": { "xc_functional": "PBE", "mixing_scheme": "anderson", "alpha_mix": 0.5 },
|
|
102
|
+
"confinement": {
|
|
103
|
+
"type": "SoftStep",
|
|
104
|
+
"rc": 20.0,
|
|
105
|
+
"ri_factor": 0.5,
|
|
106
|
+
"polarization_mode": "SoftCoul"
|
|
107
|
+
},
|
|
108
|
+
"output": { "output_wfc_qe": true, "output_wfc_bessel": true }
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
```console
|
|
113
|
+
$ cd examples
|
|
114
|
+
$ atomic_femdvr pseudoatomic Si_Pseudo.json -t scf,nscf out
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
This solves the Kohn-Sham equations self-consistently (`scf`), computes two
|
|
118
|
+
confined radial functions each for s, p and d (`nscf`), and writes them to `out/`.
|
|
119
|
+
All energies are in Hartree and all lengths in bohr. The all-electron solver is
|
|
120
|
+
run with `atomic_femdvr atomic` (see `examples/Ne_full.json`).
|
|
121
|
+
|
|
122
|
+
See the [documentation](https://atomic-femdvr.readthedocs.io) for the input
|
|
123
|
+
reference, the method and the output formats.
|
|
124
|
+
|
|
125
|
+
## ✅ Validation
|
|
126
|
+
|
|
127
|
+
- **All-electron**: LDA eigenvalues agree with the
|
|
128
|
+
[NIST atomic reference data](https://www.nist.gov/pml/atomic-reference-data-electronic-structure-calculations)
|
|
129
|
+
(Ne, to 2e-6 Ha).
|
|
130
|
+
- **Pseudo-atoms**: eigenvalues reproduce the all-electron reference energies
|
|
131
|
+
stored by ONCVPSP in the UPF file to about 0.5 meV (Mo, Si).
|
|
132
|
+
|
|
133
|
+
The scalar-relativistic and ZORA options are approximate and have not been
|
|
134
|
+
benchmarked. Details are in the
|
|
135
|
+
[documentation](https://atomic-femdvr.readthedocs.io/en/latest/validation.html).
|
|
136
|
+
|
|
137
|
+
## 📖 Citation
|
|
138
|
+
|
|
139
|
+
If you use atomic-femdvr in your work, please cite it as described in
|
|
140
|
+
[CITATION.cff](CITATION.cff).
|
|
141
|
+
|
|
142
|
+
## ⚖️ License
|
|
143
|
+
|
|
144
|
+
The code is licensed under the MIT License. The test pseudopotentials in
|
|
145
|
+
`tests/data` are taken from [PseudoDojo](http://www.pseudo-dojo.org) (M. J. van
|
|
146
|
+
Setten et al., Comput. Phys. Commun. **226**, 39 (2018)) and distributed under
|
|
147
|
+
CC BY 4.0; see [tests/data/README.md](tests/data/README.md).
|
|
148
|
+
|
|
149
|
+
## 👐 Contributing
|
|
150
|
+
|
|
151
|
+
Contributions, whether filing an issue, making a pull request, or forking, are
|
|
152
|
+
appreciated. See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more
|
|
153
|
+
information.
|
|
154
|
+
|
|
155
|
+
### Development installation
|
|
156
|
+
|
|
157
|
+
```console
|
|
158
|
+
$ git clone https://github.com/michaelschueler/atomic-femdvr.git
|
|
159
|
+
$ cd atomic-femdvr
|
|
160
|
+
$ python3 -m pip install -e .
|
|
161
|
+
$ python3 -m pytest tests
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
The NIST benchmark test is skipped unless `pylibxc` is installed. With
|
|
165
|
+
[tox](https://tox.wiki) installed (`pip install tox tox-uv`), `tox -e py` runs
|
|
166
|
+
the tests, `tox -e lint` the linter and `tox -e docs` builds the documentation in
|
|
167
|
+
`docs/build/html`.
|
|
168
|
+
|
|
169
|
+
### Making a release
|
|
170
|
+
|
|
171
|
+
`tox -e finish` removes the `-dev` suffix from the version, builds and uploads
|
|
172
|
+
the package to PyPI, tags the release, and bumps the version. It needs a PyPI
|
|
173
|
+
token in the keyring (`keyring set https://upload.pypi.org/legacy/ __token__`).
|
|
174
|
+
After pushing, create a release on GitHub from the new tag.
|
|
175
|
+
|
|
176
|
+
### 🍪 Template
|
|
177
|
+
|
|
178
|
+
This package was created from
|
|
179
|
+
[@cthoyt](https://github.com/cthoyt)'s
|
|
180
|
+
[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)
|
|
181
|
+
template.
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
<h1 align="center">
|
|
2
|
+
atomic-femdvr
|
|
3
|
+
</h1>
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://github.com/michaelschueler/atomic-femdvr/actions/workflows/tests.yml">
|
|
7
|
+
<img alt="Tests" src="https://github.com/michaelschueler/atomic-femdvr/actions/workflows/tests.yml/badge.svg" /></a>
|
|
8
|
+
<a href="https://pypi.org/project/atomic_femdvr">
|
|
9
|
+
<img alt="PyPI" src="https://img.shields.io/pypi/v/atomic_femdvr" /></a>
|
|
10
|
+
<a href="https://pypi.org/project/atomic_femdvr">
|
|
11
|
+
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/atomic_femdvr" /></a>
|
|
12
|
+
<a href="https://github.com/michaelschueler/atomic-femdvr/blob/main/LICENSE">
|
|
13
|
+
<img alt="License" src="https://img.shields.io/pypi/l/atomic_femdvr" /></a>
|
|
14
|
+
<a href="https://atomic-femdvr.readthedocs.io/en/latest/?badge=latest">
|
|
15
|
+
<img alt="Documentation Status" src="https://readthedocs.org/projects/atomic-femdvr/badge/?version=latest" /></a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
Kohn-Sham solver for isolated atoms using the finite-element discrete variable
|
|
19
|
+
representation (FE-DVR).
|
|
20
|
+
|
|
21
|
+
- **Pseudo-atoms** with norm-conserving pseudopotentials in UPF format, including
|
|
22
|
+
pseudopotentials without pseudo-atomic orbitals (e.g. SG15)
|
|
23
|
+
- **All-electron atoms** (non-relativistic), plus approximate scalar-relativistic
|
|
24
|
+
(Koelling-Harmon) and ZORA treatments
|
|
25
|
+
- LDA and GGA functionals: PBE built in, all others via
|
|
26
|
+
[libxc](https://libxc.gitlab.io)
|
|
27
|
+
- **Confined atomic orbitals** with polarization functions for use as localized
|
|
28
|
+
basis functions or projectors, exported on a logarithmic grid (Quantum ESPRESSO
|
|
29
|
+
style), on the FE-DVR grid, or as spherical Bessel transforms; dipole matrix
|
|
30
|
+
elements
|
|
31
|
+
- **Photoemission**: scattering phase shifts and dipole matrix elements to
|
|
32
|
+
continuum states
|
|
33
|
+
|
|
34
|
+
## 🚀 Installation
|
|
35
|
+
|
|
36
|
+
```console
|
|
37
|
+
$ python3 -m pip install atomic_femdvr
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The built-in exchange-correlation driver provides PBE. Other functionals (e.g. the
|
|
41
|
+
LDA used for the NIST benchmark) need the libxc Python bindings, which are not on
|
|
42
|
+
PyPI; see the
|
|
43
|
+
[installation guide](https://atomic-femdvr.readthedocs.io/en/latest/installation.html).
|
|
44
|
+
|
|
45
|
+
## 💪 Getting started
|
|
46
|
+
|
|
47
|
+
Calculations are defined by a JSON input file. A pseudo-atom with a confinement
|
|
48
|
+
potential and polarization orbitals (`examples/Si_Pseudo.json`):
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"control": { "storage_dir": "./Si_pseudo" },
|
|
53
|
+
"sysparams": {
|
|
54
|
+
"element": "Si",
|
|
55
|
+
"file_upf": "../tests/data/Si/Si.oncvpsp.upf",
|
|
56
|
+
"lmax": 2,
|
|
57
|
+
"nmax": 1
|
|
58
|
+
},
|
|
59
|
+
"dft": { "xc_functional": "PBE", "mixing_scheme": "anderson", "alpha_mix": 0.5 },
|
|
60
|
+
"confinement": {
|
|
61
|
+
"type": "SoftStep",
|
|
62
|
+
"rc": 20.0,
|
|
63
|
+
"ri_factor": 0.5,
|
|
64
|
+
"polarization_mode": "SoftCoul"
|
|
65
|
+
},
|
|
66
|
+
"output": { "output_wfc_qe": true, "output_wfc_bessel": true }
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
```console
|
|
71
|
+
$ cd examples
|
|
72
|
+
$ atomic_femdvr pseudoatomic Si_Pseudo.json -t scf,nscf out
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
This solves the Kohn-Sham equations self-consistently (`scf`), computes two
|
|
76
|
+
confined radial functions each for s, p and d (`nscf`), and writes them to `out/`.
|
|
77
|
+
All energies are in Hartree and all lengths in bohr. The all-electron solver is
|
|
78
|
+
run with `atomic_femdvr atomic` (see `examples/Ne_full.json`).
|
|
79
|
+
|
|
80
|
+
See the [documentation](https://atomic-femdvr.readthedocs.io) for the input
|
|
81
|
+
reference, the method and the output formats.
|
|
82
|
+
|
|
83
|
+
## ✅ Validation
|
|
84
|
+
|
|
85
|
+
- **All-electron**: LDA eigenvalues agree with the
|
|
86
|
+
[NIST atomic reference data](https://www.nist.gov/pml/atomic-reference-data-electronic-structure-calculations)
|
|
87
|
+
(Ne, to 2e-6 Ha).
|
|
88
|
+
- **Pseudo-atoms**: eigenvalues reproduce the all-electron reference energies
|
|
89
|
+
stored by ONCVPSP in the UPF file to about 0.5 meV (Mo, Si).
|
|
90
|
+
|
|
91
|
+
The scalar-relativistic and ZORA options are approximate and have not been
|
|
92
|
+
benchmarked. Details are in the
|
|
93
|
+
[documentation](https://atomic-femdvr.readthedocs.io/en/latest/validation.html).
|
|
94
|
+
|
|
95
|
+
## 📖 Citation
|
|
96
|
+
|
|
97
|
+
If you use atomic-femdvr in your work, please cite it as described in
|
|
98
|
+
[CITATION.cff](CITATION.cff).
|
|
99
|
+
|
|
100
|
+
## ⚖️ License
|
|
101
|
+
|
|
102
|
+
The code is licensed under the MIT License. The test pseudopotentials in
|
|
103
|
+
`tests/data` are taken from [PseudoDojo](http://www.pseudo-dojo.org) (M. J. van
|
|
104
|
+
Setten et al., Comput. Phys. Commun. **226**, 39 (2018)) and distributed under
|
|
105
|
+
CC BY 4.0; see [tests/data/README.md](tests/data/README.md).
|
|
106
|
+
|
|
107
|
+
## 👐 Contributing
|
|
108
|
+
|
|
109
|
+
Contributions, whether filing an issue, making a pull request, or forking, are
|
|
110
|
+
appreciated. See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more
|
|
111
|
+
information.
|
|
112
|
+
|
|
113
|
+
### Development installation
|
|
114
|
+
|
|
115
|
+
```console
|
|
116
|
+
$ git clone https://github.com/michaelschueler/atomic-femdvr.git
|
|
117
|
+
$ cd atomic-femdvr
|
|
118
|
+
$ python3 -m pip install -e .
|
|
119
|
+
$ python3 -m pytest tests
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
The NIST benchmark test is skipped unless `pylibxc` is installed. With
|
|
123
|
+
[tox](https://tox.wiki) installed (`pip install tox tox-uv`), `tox -e py` runs
|
|
124
|
+
the tests, `tox -e lint` the linter and `tox -e docs` builds the documentation in
|
|
125
|
+
`docs/build/html`.
|
|
126
|
+
|
|
127
|
+
### Making a release
|
|
128
|
+
|
|
129
|
+
`tox -e finish` removes the `-dev` suffix from the version, builds and uploads
|
|
130
|
+
the package to PyPI, tags the release, and bumps the version. It needs a PyPI
|
|
131
|
+
token in the keyring (`keyring set https://upload.pypi.org/legacy/ __token__`).
|
|
132
|
+
After pushing, create a release on GitHub from the new tag.
|
|
133
|
+
|
|
134
|
+
### 🍪 Template
|
|
135
|
+
|
|
136
|
+
This package was created from
|
|
137
|
+
[@cthoyt](https://github.com/cthoyt)'s
|
|
138
|
+
[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)
|
|
139
|
+
template.
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["uv_build>=0.6.6,<1.0"]
|
|
3
|
+
build-backend = "uv_build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "atomic_femdvr"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Kohn-Sham solver for isolated atoms (all-electron and norm-conserving pseudopotentials) using the finite-element discrete variable representation"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
classifiers = [
|
|
11
|
+
"Development Status :: 3 - Alpha",
|
|
12
|
+
"Environment :: Console",
|
|
13
|
+
"Intended Audience :: Science/Research",
|
|
14
|
+
"License :: OSI Approved :: MIT License",
|
|
15
|
+
"Operating System :: OS Independent",
|
|
16
|
+
"Natural Language :: English",
|
|
17
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
18
|
+
"Topic :: Scientific/Engineering :: Chemistry",
|
|
19
|
+
"Programming Language :: Python",
|
|
20
|
+
"Programming Language :: Python :: 3.10",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
25
|
+
"Typing :: Typed",
|
|
26
|
+
]
|
|
27
|
+
keywords = [
|
|
28
|
+
"density functional theory",
|
|
29
|
+
"Kohn-Sham",
|
|
30
|
+
"atom",
|
|
31
|
+
"pseudopotential",
|
|
32
|
+
"UPF",
|
|
33
|
+
"finite element",
|
|
34
|
+
"discrete variable representation",
|
|
35
|
+
"atomic orbitals",
|
|
36
|
+
"snekpack",
|
|
37
|
+
]
|
|
38
|
+
license-files = ["LICENSE"]
|
|
39
|
+
requires-python = ">=3.10"
|
|
40
|
+
dependencies = [
|
|
41
|
+
"click",
|
|
42
|
+
"typing-extensions",
|
|
43
|
+
"numpy",
|
|
44
|
+
"scipy",
|
|
45
|
+
"pydantic>=2",
|
|
46
|
+
"upf_tools",
|
|
47
|
+
"h5py",
|
|
48
|
+
"sympy",
|
|
49
|
+
]
|
|
50
|
+
|
|
51
|
+
[[project.authors]]
|
|
52
|
+
name = "Michael Schüler"
|
|
53
|
+
email = "michael.schueler@psi.ch"
|
|
54
|
+
|
|
55
|
+
[[project.maintainers]]
|
|
56
|
+
name = "Michael Schüler"
|
|
57
|
+
email = "michael.schueler@psi.ch"
|
|
58
|
+
|
|
59
|
+
[project.optional-dependencies]
|
|
60
|
+
plot = ["matplotlib"]
|
|
61
|
+
|
|
62
|
+
[project.urls]
|
|
63
|
+
"Bug Tracker" = "https://github.com/michaelschueler/atomic-femdvr/issues"
|
|
64
|
+
Homepage = "https://github.com/michaelschueler/atomic-femdvr"
|
|
65
|
+
Repository = "https://github.com/michaelschueler/atomic-femdvr.git"
|
|
66
|
+
Documentation = "https://atomic-femdvr.readthedocs.io"
|
|
67
|
+
|
|
68
|
+
[project.scripts]
|
|
69
|
+
atomic_femdvr = "atomic_femdvr.cli:main"
|
|
70
|
+
|
|
71
|
+
[dependency-groups]
|
|
72
|
+
tests = [
|
|
73
|
+
{ include-group = "pylibxc" },
|
|
74
|
+
"pytest",
|
|
75
|
+
"pytest-console-scripts",
|
|
76
|
+
"coverage[toml]",
|
|
77
|
+
]
|
|
78
|
+
pylibxc = ["pylibxc @ git+https://gitlab.com/libxc/libxc.git"]
|
|
79
|
+
docs = [
|
|
80
|
+
"sphinx>=8",
|
|
81
|
+
"sphinx-rtd-theme>=3.0",
|
|
82
|
+
"sphinx-click",
|
|
83
|
+
"sphinx_automodapi",
|
|
84
|
+
]
|
|
85
|
+
lint = ["ruff"]
|
|
86
|
+
typing = [
|
|
87
|
+
{ include-group = "tests" },
|
|
88
|
+
"mypy",
|
|
89
|
+
"pydantic",
|
|
90
|
+
"click-types",
|
|
91
|
+
"scipy-stubs",
|
|
92
|
+
]
|
|
93
|
+
docs-lint = [
|
|
94
|
+
{ include-group = "docs" },
|
|
95
|
+
"doc8",
|
|
96
|
+
]
|
|
97
|
+
format-docs = [
|
|
98
|
+
{ include-group = "docs" },
|
|
99
|
+
"docstrfmt",
|
|
100
|
+
]
|
|
101
|
+
doctests = [
|
|
102
|
+
"xdoctest",
|
|
103
|
+
"pygments",
|
|
104
|
+
]
|
|
105
|
+
pyroma = [
|
|
106
|
+
"pyroma",
|
|
107
|
+
"pygments",
|
|
108
|
+
]
|
|
109
|
+
bump = ["bump-my-version"]
|
|
110
|
+
build = [
|
|
111
|
+
"uv",
|
|
112
|
+
"uv-build",
|
|
113
|
+
]
|
|
114
|
+
release = [
|
|
115
|
+
{ include-group = "build" },
|
|
116
|
+
"uv",
|
|
117
|
+
"keyring",
|
|
118
|
+
]
|
|
119
|
+
|
|
120
|
+
[tool.cruft]
|
|
121
|
+
skip = [
|
|
122
|
+
"**/__init__.py",
|
|
123
|
+
"tests/*",
|
|
124
|
+
]
|
|
125
|
+
|
|
126
|
+
[tool.mypy]
|
|
127
|
+
plugins = ["pydantic.mypy"]
|
|
128
|
+
|
|
129
|
+
[tool.doc8]
|
|
130
|
+
max-line-length = 120
|
|
131
|
+
|
|
132
|
+
[tool.pytest.ini_options]
|
|
133
|
+
markers = ["""slow: marks tests as slow (deselect with '-m "not slow"')"""]
|
|
134
|
+
|
|
135
|
+
[tool.coverage.run]
|
|
136
|
+
branch = true
|
|
137
|
+
source = ["atomic_femdvr"]
|
|
138
|
+
omit = [
|
|
139
|
+
"tests/*",
|
|
140
|
+
"docs/*",
|
|
141
|
+
"src/atomic_femdvr/version.py",
|
|
142
|
+
"src/atomic_femdvr/__main__.py",
|
|
143
|
+
"src/atomic_femdvr/cli.py",
|
|
144
|
+
]
|
|
145
|
+
|
|
146
|
+
[tool.coverage.paths]
|
|
147
|
+
source = [
|
|
148
|
+
"src/atomic_femdvr",
|
|
149
|
+
".tox/*/lib/python*/site-packages/atomic_femdvr",
|
|
150
|
+
]
|
|
151
|
+
|
|
152
|
+
[tool.coverage.report]
|
|
153
|
+
show_missing = true
|
|
154
|
+
exclude_lines = [
|
|
155
|
+
"pragma: no cover",
|
|
156
|
+
"raise NotImplementedError",
|
|
157
|
+
'if __name__ == "__main__":',
|
|
158
|
+
"if TYPE_CHECKING:",
|
|
159
|
+
"def __str__",
|
|
160
|
+
"def __repr__",
|
|
161
|
+
]
|
|
162
|
+
|
|
163
|
+
[tool.ruff]
|
|
164
|
+
line-length = 120
|
|
165
|
+
|
|
166
|
+
[tool.ruff.lint]
|
|
167
|
+
select = [
|
|
168
|
+
"F",
|
|
169
|
+
"E",
|
|
170
|
+
"W",
|
|
171
|
+
"I",
|
|
172
|
+
"UP",
|
|
173
|
+
"B",
|
|
174
|
+
"NPY",
|
|
175
|
+
"RUF",
|
|
176
|
+
]
|
|
177
|
+
ignore = [
|
|
178
|
+
"E501",
|
|
179
|
+
"E731",
|
|
180
|
+
"E741",
|
|
181
|
+
"RUF001",
|
|
182
|
+
"RUF002",
|
|
183
|
+
"RUF003",
|
|
184
|
+
]
|
|
185
|
+
|
|
186
|
+
[tool.ruff.lint.isort]
|
|
187
|
+
known-first-party = [
|
|
188
|
+
"atomic_femdvr",
|
|
189
|
+
"tests",
|
|
190
|
+
]
|
|
191
|
+
|
|
192
|
+
[tool.bumpversion]
|
|
193
|
+
current_version = "0.1.0"
|
|
194
|
+
parse = '(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<release>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+(?P<build>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?'
|
|
195
|
+
serialize = [
|
|
196
|
+
"{major}.{minor}.{patch}-{release}+{build}",
|
|
197
|
+
"{major}.{minor}.{patch}+{build}",
|
|
198
|
+
"{major}.{minor}.{patch}-{release}",
|
|
199
|
+
"{major}.{minor}.{patch}",
|
|
200
|
+
]
|
|
201
|
+
commit = true
|
|
202
|
+
tag = false
|
|
203
|
+
|
|
204
|
+
[tool.bumpversion.parts.release]
|
|
205
|
+
optional_value = "production"
|
|
206
|
+
first_value = "dev"
|
|
207
|
+
values = [
|
|
208
|
+
"dev",
|
|
209
|
+
"production",
|
|
210
|
+
]
|
|
211
|
+
|
|
212
|
+
[[tool.bumpversion.files]]
|
|
213
|
+
filename = "pyproject.toml"
|
|
214
|
+
search = 'version = "{current_version}"'
|
|
215
|
+
replace = 'version = "{new_version}"'
|
|
216
|
+
|
|
217
|
+
[[tool.bumpversion.files]]
|
|
218
|
+
filename = "docs/source/conf.py"
|
|
219
|
+
search = 'release = "{current_version}"'
|
|
220
|
+
replace = 'release = "{new_version}"'
|
|
221
|
+
|
|
222
|
+
[[tool.bumpversion.files]]
|
|
223
|
+
filename = "src/atomic_femdvr/version.py"
|
|
224
|
+
search = 'VERSION = "{current_version}"'
|
|
225
|
+
replace = 'VERSION = "{new_version}"'
|
|
226
|
+
|
|
227
|
+
[[tool.bumpversion.files]]
|
|
228
|
+
filename = "CITATION.cff"
|
|
229
|
+
search = "version: {current_version}"
|
|
230
|
+
replace = "version: {new_version}"
|