Installation

Requirements

  • Python 3.10 – 3.13

  • NumPy ≥ 1.21, PyCifRW ≥ 5.0, wgpu ≥ 0.29

  • WebGPU adapter to run simulations

CIF files are read with PyCifRW (Hermann–Mauguin symbols and mixed-case tags are accepted). GPU setup — drivers, headless Linux, cloud VMs — follows the wgpu-py installation guide.

Loading saved .npz files via ebsdsim.mploader needs only NumPy.

PyPI

pip install ebsdsim

If import ebsdsim works but simulation fails with a GPU error, see wgpu-py platform requirements.

From source

git clone https://github.com/ZacharyVarley/ebsdsim.git
cd ebsdsim
pip install -e ".[dev,docs]"

See CONTRIBUTING.md on GitHub for development and releases.