Skip to main content

ebsdsim — dynamical EBSD master patterns

ebsdsim

CI Documentation Python License: MIT

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ebsdsim-0.2.4.tar.gz (916.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ebsdsim-0.2.4-py3-none-any.whl (539.9 kB view details)

Uploaded Python 3

File details

Details for the file ebsdsim-0.2.4.tar.gz.

File metadata

  • Download URL: ebsdsim-0.2.4.tar.gz
  • Upload date:
  • Size: 916.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ebsdsim-0.2.4.tar.gz
Algorithm Hash digest
SHA256 43ab2c624b8b2861b13476241e1ed8bc94d2a35e2ee7b643f88626eec6f9d84b
MD5 6852755dda398e5d9676f281d10e77d0
BLAKE2b-256 5638fcb5c0f1caf41e3c5adc6b918c782c6a5670af19ea1894e461828105df9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ebsdsim-0.2.4.tar.gz:

Publisher: release.yml on ZacharyVarley/ebsdsim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ebsdsim-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: ebsdsim-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 539.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ebsdsim-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e4528e65d00f1417416c52092bf8de3d8ec30ca52784db4cf3b4b9d4421b5767
MD5 48536d9e4d7feab7edf3a5ffee10484d
BLAKE2b-256 6ee99f468e8a5b75b182984e65f5ffdb418e800393ec162415b7ff2cf0d7aac6

See more details on using hashes here.

Provenance

The following attestation bundles were made for ebsdsim-0.2.4-py3-none-any.whl:

Publisher: release.yml on ZacharyVarley/ebsdsim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page