gpatom: Tools for atomistic simulations based on Gaussian processes
gpatom is a Python package which provides several tools for geometry optimisation and related tasks in atomistic systems using machine learning surrogate models. gpatom is an extension to the Atomic Simulation Environment.
gpatom consists of two independently maintained sub-repositories, gpatom/aidts-gpmin and gpatom/ase-gpatom.
- gpatom/aidts-gpmin includes:
GPMin: An atomistic optimization algorithm based on Gaussian processes.
AIDMin: Energy structure minimization through the Artificial-Intelligence framework.
AIDNEB: Nudged Elastic Band calculations through the Artificial-Intelligence framework.
AIDTS: Transition State Search through the Artificial-Intelligence framework.
AIDMEP: Minimum Energy Pathway through the Artificial-Intelligence framework.
- gpatom/ase-gpatom includes:
- BEACON: Bayesian Exploration of Atomic CONfigurations.
BEACON does global optimization by Bayesian optimization by training the model with the DFT forces on atoms. Represents the atoms with a global structural fingerprint. Works generally well for different kinds of atomic systems: clusters, surfaces, bulk systems. For usage, see Gitlab Wiki: https://gitlab.com/gpatom/ase-gpatom/-/wikis/How-to-use-BEACON
- List of related publications for gpatom/ase-gpatom:
- BEACON:
Global optimization of atomic structures with gradient-enhanced Gaussian process regression
S. Kaappa, E. G. del Río, K. W. Jacobsen
Physical Review B, vol. 103, 174114 (2021). https://doi.org/10.1103/PhysRevB.103.174114
- ICE-BEACON:
Atomic Structure Optimization with Machine-Learning Enabled Interpolation between Chemical Elements
S. Kaappa, C. Larsen, K. W. Jacobsen
Physical Review Letters, vol. 127, 166001 (2021). https://doi.org/10.1103/PhysRevLett.127.166001
- Ghost-BEACON:
Machine-learning-enabled optimization of atomic structures using atoms with fractional existence
C. Larsen, S. Kaappa, A. L. Vishart, T. Bligaard, K. W. Jacobsen
Physical Review B, vol. 107, 214101 (2023). https://doi.org/10.1103/PhysRevB.107.214101
- BEACON with MACE prior:
Bayesian optimization of atomic structures with prior probabilities from universal interatomic potentials
P. Lyngby, C. Larsen, K. W. Jacobsen
Physical Review Materials, vol. 8, 123802 (2024). https://doi.org/10.1103/PhysRevMaterials.8.123802
- ICE, Ghost and Hyperspatial optimization generalized to arbitrary many elements and variable unit cell:
Global atomic structure optimization through machine- learning-enabled barrier circumvention in extra dimensions
C. Larsen, S. Kaappa, A. L. Vishart, T. Bligaard, K. W. Jacobsen
npj computational materials, 11, 222 (2025). https://doi.org/10.1038/s41524-025-01656-9
Contact
Please join our #gpatom channel on Matrix.
Installation cheat sheet
To install latest release from pypi, use:
$ pip install ase-gpatom
To install a developer version (allows in-place edits of the code), clone the sourcecode and go to the toplevel gpatom directory, then run:
$ git clone https://gitlab.com/gpatom/ase-gpatom.git $ pip install --editable ase-gpatom
Testing cheat sheet
To run the tests, go to the test directory and run:
$ pytest
Run the tests in parallel on n cores (requires pytest-xdist):
$ pytest -n 4
Show tests without running them:
$ pytest --collectonly
Run tests in particular module:
$ pytest test_module.py
Run tests matching pattern:
$ pytest -k <pattern>
Show output from tests:
$ pytest -s
Note that since many tests write files, temporary directories are created for each test. The temporary directories are located in /tmp/pytest-of-<username>/. pytest takes care of cleaning up these test directories.
Use pytest.ini and test/conftest.py to customize how the tests run.
Metadata
Release files for ase-gpatom 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ase_gpatom-1.0.0.tar.gz | 151.8 kB | Without provenance | Details for ase_gpatom-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ase_gpatom-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for ase_gpatom-1.0.0-py3-none-any.whl |
Total release size: 313.9 kB
Release files / ase_gpatom-1.0.0.tar.gz
| Download URL | ase_gpatom-1.0.0.tar.gz |
|---|---|
| Size | 151.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7b959c69221295383f03d54a2b9439e7e291d9b502f6677531449733f633e678
|
|
BLAKE2b-256 checksum How to use checksums |
cfaef05189d2ffb3f597aa8569564723f2571f2f1758e1ee89c75aa274c5aa36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.12
|
Release files / ase_gpatom-1.0.0-py3-none-any.whl
| Download URL | ase_gpatom-1.0.0-py3-none-any.whl |
|---|---|
| Size | 162.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
15daa51cff3736409d38a780e5cbe07de769c5cc5f55367ee4f30ac1923c9e6d
|
|
BLAKE2b-256 checksum How to use checksums |
dc49fc06f1ed2bdd60782b8d1ce698cf11940bd2602cb907aeaa7c6756c4c45d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.12
|
Security for ase-gpatom 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.