grogupy: Relativistic magnetic interactions from non-orthogonal basis sets
grogupy is an open-source package created to easily extract magnetic interaction parameters from density functional theory (DFT) calculations. It can also handle very large systems, with hundreds of atoms in the unit cell using GPU acceleration. Because the underlying theory focuses on non-orthogonal, LCAO, basis sets, the most straightforward software, and our recommendation to use for the DFT part is Siesta. In principle any plane wave based DFT software could be used with Wannierization, but the magnetic parameters are very sensitive to the atomic positions and Wannier orbitals might be off centered. grogupy can extract magnetic parameters from different levels of theoretical complexity, for example it can use as input collinear, non-collinear and spin-orbit Hamiltonians using sisl. More on the theoretical background can be found on arXiv. grogupy was created by the TRILMAX Consortium.
Features
- Flexible API to set up more complicated systems with complex magnetic entities
- Command line interface to extract and visualize the magnetic parameters
- Multiple output formats for atomistic spin dynamics softwares
- Interactive visualizations for system exploration
Tutorials and examples
You can start with the Quick start guides or learn more about the best practices in the Tutorials section.
Documentation
The documentation can be found here, and the API reference is here.
Installation
grogupy can be installed using pip:
pip install grogupy
Or you can install optional dependecies, like visualization packages or packages for MPI or GPU acceleration:
pip install grogupy[viz,mpi,gpu]
1 maintainer
Release files for grogupy 0.4.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 | |
|---|---|---|---|
| grogupy-0.4.0.tar.gz | 3.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| grogupy-0.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.3 MB
Release files / grogupy-0.4.0.tar.gz
| Download URL | grogupy-0.4.0.tar.gz |
|---|---|
| Size | 3.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8e063acd40a2334e8e2c0e9b10fa4af483cd1c69c2d86381f9aa4a4af09a7fe2
|
|
BLAKE2b-256 checksum How to use checksums |
8940c9d98833b1b0fc076a308ad20a79e6b079cf3699778f3f0bee23ffbaa152
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 27, 2025.
Transparency logRelease files / grogupy-0.4.0-py3-none-any.whl
| Download URL | grogupy-0.4.0-py3-none-any.whl |
|---|---|
| Size | 181.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8ce0fb0fecd44aaa6e027a8792083865125467642fdfef960a09c66697df3b7b
|
|
BLAKE2b-256 checksum How to use checksums |
4fb4059761e37015aadc1e487d13d4e25155387ab9ea4cef0718259def4458f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 27, 2025.
Transparency log
