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,
    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.1.tar.gz (874.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.1-py3-none-any.whl (492.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ebsdsim-0.2.1.tar.gz
  • Upload date:
  • Size: 874.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.1.tar.gz
Algorithm Hash digest
SHA256 2145efb776b2774ea8772a12da6e0a1c86af54c9cb813bf6972cc1f45e360443
MD5 71b5e6fdf1ae0494eca7067223aa24ce
BLAKE2b-256 2a8cbb42a98ccd81b3e5672d250145792905360a77bc770c58cd5773cfba7f3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for ebsdsim-0.2.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: ebsdsim-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 492.6 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ebeb23d8253176effeb1c952dec3bac08a17724e3a174eeda2e137bfab06510a
MD5 57e0302d8f5663530e2f0a0991edcf19
BLAKE2b-256 ca21e33426c60ed0aa10369108f08dfdc941486f4d008e3828c1324aea78d0a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ebsdsim-0.2.1-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