Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

ASE2SPRKKR — a Python interface for SPR-KKR

Ase2sprkkr is a modern, comprehensive replacement for XBAND, providing a unified framework for SPR-KKR calculations, ranging from easy interactive use to efficient, highly automated workflows on HPC systems. It integrates with the Atomic Simulation Environment (ASE) and supports preparing, running, and analyzing calculations through Python.

SPR-KKR uses the multiple-scattering KKR Green's-function method and supports electronic structure, magnetism, chemically disordered alloys (CPA), Bloch spectral functions and spectroscopy. See the SPR-KKR manual for the physics and numerical choices; this documentation focuses on the Python interface.

ASE2SPRKKR creates input files and starting potentials from ASE structures, runs native SPR-KKR tasks and parses supported results. KKRunner provides local, MPI, SSH and scheduler execution. SPR-KKR executables are installed separately; they are not included in the Python distribution.

Start here

Install or upgrade the latest stable release:

python -m pip install --upgrade ase2sprkkr
ase2sprkkr --version

To install an available beta release (including the 4.0 series), use python -m pip install --upgrade --pre ase2sprkkr. Some features described in the development documentation may not yet be available in a published version.

For a separate test environment or a distribution-managed Python installation, see virtual environments.

The native executables (e.g. kkrscf and kkrgen) can be found on PATH or configured through the active execution profile:

ase2sprkkr config --set profiles.default.executable_dir /opt/sprkkr/bin

The profiles.default alias uses an explicitly selected named profile or otherwise ASE's [sprkkr] configuration. To edit the ASE profile directly, use profiles.ase. A suffix can also be configured:

ase2sprkkr config --set profiles.ase.executable_suffix _v8

A short SCF calculation starts with ASE atoms:

from ase.build import bulk
from ase2sprkkr import SPRKKR

result = SPRKKR(atoms=bulk("Al", "fcc", a=4.05)).calculate()
print("Energy (eV):", result.energy)
print("SCF converged:", result.converged)
print("Potential:", result.potential_filename)

Always check convergence before reusing an SCF potential for other tasks. The first-calculation tutorial continues with a DOS calculation. For more examples of calculations with ASE2SPRKKR, see the ASE2SPRKKR paper (Eddhib et al., 2026).

Further documentation

For upgrades from ASE2SPRKKR 3.x, configuration migration and optional features such as plotting or NeXus export, see the installation guide.

Contributing

Report problems and propose changes on GitHub.

Metadata

Release files for ase2sprkkr 4.0.0b5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ase2sprkkr 4.0.0b5
File Size Uploaded Provenance Actions
ase2sprkkr-4.0.0b5.tar.gz 33.9 MB With provenance Details for ase2sprkkr-4.0.0b5.tar.gz

Release files / ase2sprkkr-4.0.0b5.tar.gz

Download URL ase2sprkkr-4.0.0b5.tar.gz
Size 33.9 MB
Tags Source
SHA-256 checksum
How to use checksums
57f3208ea8c6391f7c7c7d722a049bbbb00d8a18b134f6cc81ac6069c4ac1b81
BLAKE2b-256 checksum
How to use checksums
f77af08940f6768e1317bc985d778103fb3cedbc5eaf8355ca7288a0bdef6580
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 16, 2026.

Transparency log

Security for ase2sprkkr 4.0.0b5

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.

Full provenance

1 file in this release has been uploaded with provenance metadata.

Attestation for ase2sprkkr-4.0.0b5.tar.gz

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 Nov 16, 2026.

Transparency log

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.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page