Installation

Requirements

• Python 3.10 – 3.13

• NumPy ≥ 1.21, wgpu ≥ 0.29

• WebGPU adapter to run simulations

CIF files are standardized to the International Tables setting on load via the vendored cif_reader package (dual-origin groups use origin choice 2). GPU setup — drivers, headless Linux, cloud VMs — follows the wgpu-py installation guide.

Loading saved .npz files via ebsdsim.io.load needs NumPy (and the shared Lambert helpers in ebsdsim.lambert).

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.