Metadata-Version: 2.4
Name: ase2sprkkr
Version: 4.0.0b5
Summary: Wrapper/calculator for SPR-KKR to be used within ASE (Atomic Simulation Environment)
Author: Jano Minár, Ridha Eddhib
Author-Email: =?utf-8?b?TWF0ecOhxaEgTm92w6Fr?= <novakmat@fzu.cz>, Unknown <ase2sprkkr@ntc.zcu.cz>
License-File: LICENCE
Project-URL: Homepage, https://ase2sprkkr.github.io/ase2sprkkr/
Requires-Python: >=3.9
Requires-Dist: kkrunner<0.3,>=0.2.0b3
Requires-Dist: ase>=3.22.0
Requires-Dist: colorama
Requires-Dist: spglib
Requires-Dist: pyparsing>=3.0
Requires-Dist: elementy
Requires-Dist: platformdirs
Requires-Dist: packaging
Requires-Dist: pytest
Requires-Dist: pyyaml
Requires-Dist: ruamel.yaml>=0.18.16
Requires-Dist: requests
Requires-Dist: argcomplete
Requires-Dist: unyt
Requires-Dist: numpy; python_version < "3.10"
Requires-Dist: numpy>=2.1; python_version >= "3.10"
Requires-Dist: networkx<3.3; python_version >= "3.14"
Provides-Extra: nexus
Requires-Dist: h5py>=3.8; extra == "nexus"
Requires-Dist: nexusformat>=1.0; extra == "nexus"
Provides-Extra: jupyter
Requires-Dist: jupyterlab; extra == "jupyter"
Requires-Dist: nbformat; extra == "jupyter"
Requires-Dist: nbconvert; extra == "jupyter"
Provides-Extra: mendeleev
Requires-Dist: mendeleev; extra == "mendeleev"
Provides-Extra: es-finder
Requires-Dist: pymatgen; extra == "es-finder"
Provides-Extra: plot
Requires-Dist: matplotlib; extra == "plot"
Requires-Dist: scipy; extra == "plot"
Requires-Dist: scikit-image; extra == "plot"
Provides-Extra: psij
Requires-Dist: kkrunner[psij]<0.3,>=0.2.0b3; extra == "psij"
Description-Content-Type: text/markdown

# ASE2SPRKKR — a Python interface for SPR-KKR

Ase2sprkkr is a modern, comprehensive replacement for [XBAND](https://sprkkr.org/xband/), providing a unified framework for [SPR-KKR](https://sprkkr.org/) calculations, ranging from easy interactive use to efficient, highly automated workflows on HPC systems. It integrates with the [Atomic Simulation Environment (ASE)](https://wiki.fysik.dtu.dk/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](https://sprkkr.org/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](https://ase2sprkkr.github.io/kkrunner/) provides local, MPI, SSH and scheduler execution. **SPR-KKR executables are installed separately**; they are not included in the Python distribution.

## Start here

- [First calculation: SCF to DOS](doc_src/quickstart.rst)
- [Installation, upgrading, virtual environments and optional dependencies](doc_src/installation.rst)
- [Python usage and task parameters](doc_src/usage.rst)
- [Examples generated from Python sources](doc_src/examples.rst)
- [Command-line interface](doc_src/cli.rst)

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](doc_src/installation.rst#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:

``` python
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](doc_src/quickstart.rst) continues with a DOS calculation. For more examples of calculations with ASE2SPRKKR, see the [ASE2SPRKKR paper (Eddhib et al., 2026)](https://arxiv.org/abs/2608.05957).

## Further documentation

- [Result files, plotting and NeXus](doc_src/result-files.rst)
- [Remote running, MPI and execution profiles](doc_src/remote.rst)
- [Persistent project calculations](doc_src/execution.rst)
- [Crystal symmetry](doc_src/symmetry.rst)
- [Architecture for developers and TaskDefinition](doc_src/philosophy.rst)
- [Changelog](doc_src/changelog.rst)

For upgrades from ASE2SPRKKR 3.x, configuration migration and optional features such as plotting or NeXus export, see the [installation guide](doc_src/installation.rst).

## Contributing

Report problems and propose changes on [GitHub](https://github.com/ase2sprkkr/ase2sprkkr).
