Skip to main content

Calculate diffraction patterns from first principles

Project description

License: GPL v3 Python Versions PyPI PyPI - Wheel

DiffSim

Introduction

DiffSim provides an atomistic approach to efficiently simulate Bragg coherent x-ray diffraction imaging (BCDI) diffraction patterns by factorising and eliminating certain redundancies in the conventional approach. The method used is able to reduce the computation time by several orders of magnitude without compromising the recovered phase information and therefore enables feasible atomistic simulations on nanoscale crystals with arbitrary lattice distortions.

Please cite the following article when using Diffsim in published work:

Ahmed Mokhtar, David Serban and Marcus Newton, Simulation of Bragg coherent diffraction imaging, J. Phys. Commun. Volume 6, 055003 (2022)

Installation

DiffSim requires:

  • Python >= 3.7
  • Numba >= 0.58.1
  • NumPy >= 1.25.0
  • scipy
  • mpi4py

Installation via pip:

$ pip install diffsim

Reporting Bugs

Please send any bugs, problems, and proposals to: Bonsu.Devel@gmail.com or visit: http://github.com/bonsudev/diffsim

Library Usage and Examples

Example scripts are available in the examples folder.

Version History

Version 1.2 🗓 ️(02/11/2023)

🔧 Minor bug fixes.

Version 1.1 🗓 ️(29/10/2023)

✨ Refactored code for speed improvements.
✨ Added attenuation and refraction corrections.
🔧 Minor bug fixes.

Version 1.0 🗓 ️(14/09/2022)

✨ First major release. 

Licence

GNU GPLv3

Project details


Download files

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

Source Distribution

diffsim-1.2.tar.gz (52.1 kB view details)

Uploaded Source

Built Distribution

diffsim-1.2-py3-none-any.whl (43.4 kB view details)

Uploaded Python 3

File details

Details for the file diffsim-1.2.tar.gz.

File metadata

  • Download URL: diffsim-1.2.tar.gz
  • Upload date:
  • Size: 52.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.13

File hashes

Hashes for diffsim-1.2.tar.gz
Algorithm Hash digest
SHA256 cf822064cf465c54e0a0b66a277c52a6aced5207f731f203836bcd0844c6cbde
MD5 c792c6e79d7804173a3efce512611345
BLAKE2b-256 bc3c2270b00a1cc93917ba13ad227f6396db9921530d4b36fa245d779cbd9171

See more details on using hashes here.

File details

Details for the file diffsim-1.2-py3-none-any.whl.

File metadata

  • Download URL: diffsim-1.2-py3-none-any.whl
  • Upload date:
  • Size: 43.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.13

File hashes

Hashes for diffsim-1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 92e2c5d3f219e2a3bd01d8d5adfb5ca24bc86987badc96e44cd90464844d578f
MD5 eee5d7bff14b8b163e1d8bbe9bf4e832
BLAKE2b-256 e28ee55774f19d5e4c86643b1436d40418740ad1f0e022c8393ca82c9af10304

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page