Skip to main content

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

Release files for diffsim 1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for diffsim 1.2
File Size Uploaded
diffsim-1.2.tar.gz 52.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for diffsim 1.2
File Interpreter ABI Platform
diffsim-1.2-py3-none-any.whl Python 3 none any Details

Total release size: 95.5 kB

Release files / diffsim-1.2.tar.gz

Download URL diffsim-1.2.tar.gz
Size 52.1 kB
Tags Source
SHA-256 checksum
How to use checksums
cf822064cf465c54e0a0b66a277c52a6aced5207f731f203836bcd0844c6cbde
BLAKE2b-256 checksum
How to use checksums
bc3c2270b00a1cc93917ba13ad227f6396db9921530d4b36fa245d779cbd9171
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.13

Release files / diffsim-1.2-py3-none-any.whl

Download URL diffsim-1.2-py3-none-any.whl
Size 43.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
92e2c5d3f219e2a3bd01d8d5adfb5ca24bc86987badc96e44cd90464844d578f
BLAKE2b-256 checksum
How to use checksums
e28ee55774f19d5e4c86643b1436d40418740ad1f0e022c8393ca82c9af10304
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.13

Release history Release notifications | RSS feed

This release

1.2 This release

2 release files

1.1

2 release files

1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page