ebsdsim
ebsdsim computes Lambert-projected Kikuchi master patterns from crystal structures
using multi-beam dynamical electron diffraction on the GPU (WebGPU). Patterns are
written as raw intensities in compressed .npz files; display scaling is applied
when you load them.
User documentation is at ebsdsim.readthedocs.io.
Installation
pip install ebsdsim
Simulations require a WebGPU adapter. See the installation guide for Python version support, GPU drivers, and editable installs.
Quick start
import ebsdsim as es
mp = es.master_pattern_from_cif(
"GaN.cif",
voltage_kv=20.0,
halfw=250, # 501×501 raster; the default 500 gives 1001×1001
sigma_deg=70.0,
)
mp.save("GaN-master-pattern.npz")
Bundled presets: GaN.cif, Ni.cif. See
examples/01_quick_start.ipynb.
Documentation
Development and releases: CONTRIBUTING.md.
License
MIT — see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for ebsdsim 0.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ebsdsim-0.2.4.tar.gz | 916.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ebsdsim-0.2.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.5 MB
Release files / ebsdsim-0.2.4.tar.gz
| Download URL | ebsdsim-0.2.4.tar.gz |
|---|---|
| Size | 916.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
43ab2c624b8b2861b13476241e1ed8bc94d2a35e2ee7b643f88626eec6f9d84b
|
|
BLAKE2b-256 checksum How to use checksums |
5638fcb5c0f1caf41e3c5adc6b918c782c6a5670af19ea1894e461828105df9d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 12, 2026.
Transparency logRelease files / ebsdsim-0.2.4-py3-none-any.whl
| Download URL | ebsdsim-0.2.4-py3-none-any.whl |
|---|---|
| Size | 539.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e4528e65d00f1417416c52092bf8de3d8ec30ca52784db4cf3b4b9d4421b5767
|
|
BLAKE2b-256 checksum How to use checksums |
6ee99f468e8a5b75b182984e65f5ffdb418e800393ec162415b7ff2cf0d7aac6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 12, 2026.
Transparency log
