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
  • 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.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.1.tar.gz (52.1 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: diffsim-1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 f191206f6d0f8b3450e04becff0684c6a760f1822ef9ab215e013753b155b2ce
MD5 12b0dbb6409305ccc01746141fcd67dc
BLAKE2b-256 9194b718a5d8658d409f7300ab6d5d7c079024c570dc569ac0b366e1134ed9f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: diffsim-1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e729f0c213c27bca6e9db1778185c5e56aabfac38599c47deb920895a60ea51d
MD5 c10a04b4ffa24144bf5466dc050dd931
BLAKE2b-256 87c78cb4acd644a92c226f68e8e541d81a7dd4502b7ca176d81cae52deb807ac

See more details on using hashes here.

Supported by

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